POST
/
v1
/
logs
/
raw
/
bots
Get Bots
curl --request POST \
  --url https://api.tryprofound.com/v1/logs/raw/bots \
  --header 'Content-Type: application/json' \
  --data '{
  "date_interval": "day",
  "dimensions": [],
  "metrics": [
    "<string>"
  ],
  "filters": [],
  "order_by": {
    "date": "asc"
  },
  "pagination": {
    "limit": 10000,
    "offset": 0
  },
  "domain": "<string>",
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z"
}'
[
  {
    "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>",
    "referer": "",
    "bytes_sent": 0,
    "duration_ms": 0,
    "query_params": {},
    "bot_name": "<string>",
    "bot_provider": "<string>",
    "bot_types": [
      "ai_assistant"
    ]
  }
]

Authorizations

​
api_key
string
query
required

Body

application/json
​
metrics
string[]
required
​
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:
day,
week,
month,
year
​
dimensions
enum<string>[]

Dimensions to group the report by.

​
filters
Filter[Literal['method', 'path', 'status_code', 'ip', 'user_agent', 'referer', 'query_params', 'bot_name', 'bot_provider', 'bot_types']] · object[]

List of filters to apply to the report. Each filter has an operator, field, and value.

​
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.

Examples:
{ "date": "asc" }
​
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.

Response

Successful Response

​
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
​
referer
string
default:""
​
bytes_sent
integer
default:0
​
duration_ms
integer
default:0
​
query_params
object