Skip to main content
POST
/
v1
/
logs
/
raw
/
bots
JavaScript
import Profound from '@profoundai/client';

const client = new Profound({
  apiKey: process.env['PROFOUND_API_KEY'], // This is the default and can be omitted
});

const response = await client.logs.raw.bots({
  domain: 'domain',
  metrics: ['count'],
  start_date: '2019-12-27T18:11:19.117Z',
});

console.log(response);
[
  {
    "timestamp": "2023-11-07T05:31:56Z",
    "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "method": "<string>",
    "host": "<string>",
    "path": "<string>",
    "status_code": 123,
    "ip": "<string>",
    "user_agent": "<string>",
    "bot_name": "<string>",
    "bot_provider": "<string>",
    "bot_types": [],
    "referer": "",
    "bytes_sent": 0,
    "duration_ms": 0,
    "query_params": {}
  }
]

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
metrics
string[]
required
Allowed value: "count"
​
domain
string
required

Domain to query logs for.

​
start_date
string<date-time>
required

Start date for logs. Accepts: YYYY-MM-DD, YYYY-MM-DD HH:MM, YYYY-MM-DD HH:MM:SS, or full ISO timestamp.

​
date_interval
enum<string>
default:day

Date interval for the report. (only used with date dimension)

Available options:
hour,
day,
week,
month,
year,
relative_week
​
dimensions
enum<string>[]

Dimensions to group the report by.

Available options:
timestamp,
method,
host,
path,
status_code,
ip,
user_agent,
referer,
bytes_sent,
duration_ms,
query_params
​
order_by
Order By · object

Custom ordering of the report results.

The order is a record of key-value pairs where:

  • key is the field to order by, which can be a metric or dimension
  • value is the direction of the order, either 'asc' for ascending or 'desc' for descending.

When not specified, the default order is the first metric in the query descending.

Example:
{ "date": "asc" }
​
pagination
Pagination · object

Pagination settings for the report results.

​
end_date
string<date-time>

End date for logs. Accepts same formats as start_date. Defaults to now if omitted.

​
organization_id
string<uuid> | null
​
filters
(BotNameFilter · object | BotProviderFilter · object | BotTypesFilter · object | MethodFilter · object | PathFilter · object | StatusCodeFilter · object | IpFilter · object | UserAgentFilter · object | RefererFilter · object | QueryParamsFilter · object)[]

List of filters to apply to the bots logs query.

Filter by bot name (user agent)

Response

Successful Response

DB Model for a bot visit.

​
timestamp
string<date-time>
required
​
org_id
string<uuid>
required
​
method
string
required
​
host
string
required
​
path
string
required
​
status_code
integer
required
​
ip
string
required
​
user_agent
string
required
​
bot_name
string
required
​
bot_provider
string
required
​
bot_types
enum<string>[]
required
Available options:
ai_assistant,
ai_training,
index,
ai_agent
​
referer
string
default:""
​
bytes_sent
integer
default:0
​
duration_ms
integer
default:0
​
query_params
Query Params · object