v1

latestOpenAPI 3.0.32026-07-26710398.3 KB

Project

Get Agent Visits

Aggregate agent access log visits grouped by a chosen dimension (bot, response status, host, path).

get/agent-analytics/visits

Query parameters

project_idstring

Required if using a company api key

Example:or_f45b94ba-5e35-4982-93ed-285e72ee14eb

limitnumber

offsetnumber

start_datestring date

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

Example:2025-09-22

end_datestring date

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

Example:2025-09-22

group_bystring[]

Dimension(s) to group visit counts by.

[
  "bot_id"
]

bot_idsstring[]

Optional list of bot IDs to filter by.

[
  "AppleBot",
  "GoogleBot"
]

time_bucket'hour' | 'day' | 'week' | 'month'

Optional time_bucket for grouping visits by time.

Example:day

Response

Success

total_countnumber required

Total number of grouped rows.

totalCountnumber required

Total number of grouped rows.

Example response

{
  "data": [
    {
      "bot_id": "GPTBot",
      "visits": 1402
    },
    {
      "bot_id": "AppleBot",
      "visits": 893
    }
  ],
  "total_count": 2,
  "totalCount": 2
}