COcooper-square-technologies
Agent Analytics

Get Bots

Changed on

Get identified bot logs with filters

post/v1/logs/raw/bots

Request

Request body

date_interval'hour' | 'day' | 'week' | 'month' | 'year' | 'relative_week'

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

metricsstring[] required
order_byobject

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.

domainstring required

Domain to query logs for.

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

end_datestring date-time

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

organization_idstring uuid nullable

Example request

{
  "order_by": {
    "date": "asc"
  }
}

Response

Successful Response

OR

Changes

  • cb72c86a6386Revision changes
    • breaking

      removed subschema #1 subschema #2 from the /// request property anyOf list

    • breaking

      removed subschema #1 subschema #2 from the /// request property anyOf list

    • info

      added subschema #1 subschema #2 to the /// request property anyOf list

    • info

      added subschema #1 subschema #2 to the /// request property anyOf list

  • c55c2a1636c3Revision changes
    • info

      the endpoint scheme security BearerAuth was added to the API