COcooper-square-technologies
Reports
Bot Traffic Reports

Get Bots Report V1

Changed on

Get bot traffic report from the daily aggregated materialized view.

This endpoint queries pre-aggregated daily bot data, making it efficient for large date ranges and high-traffic sites.

Metrics:

  • count: unique bot visits
  • citations: unique citation events
  • indexing: unique indexing events
  • training: unique training events
  • last_visit: most recent visit timestamp
post/v1/reports/bots

Request

Request body

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

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

dimensionsstring[]

Dimensions to group the report by.

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

Changes

  • 56d428ca479fRevision changes
    • info

      added the new optional request property

  • 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