For the complete documentation index, see llms.txt. This page is also available as Markdown.

Agent Analytics

List Agent Analytics

post

Agent Analytics: daily bot requests to the Brand Kit's tracked web pages, one row per date, platform and crawl_type with a request count. Rows with no requests are omitted. Every platform and crawl type is returned; sum the rows to reproduce the Agent Analytics tab. Paginate through every page first (loop while page <= meta.total_pages): a date range commonly has more rows than fit on one page, so summing only the first page undercounts. Tracked engines are chat_gpt, perplexity, gemini, google_ai_mode, claude. "Crawls" are rows with crawl_type ai_search or ai_training. Total Crawls: sum crawls for tracked engines. AI Agent Visits: sum user_browse for tracked engines. Top Crawling Engine: the tracked engine with the most crawls. Crawl Type Breakdown: for tracked engines, ai_search (Web Search) and ai_training (Training), each as a percentage of their combined total. Engine Breakdown: per tracked engine, ai_training (Training), ai_search (Web Search), their sum (Total Crawls) and user_browse (AI Agent Visits). Crawl Activity vs. AI Agent Visits chart: per date, sum each crawl_type across all platforms, including generic crawlers such as google and bing. AI Agent Visits over time: user_browse per date per platform; the chart shows tracked engines. Filter by web_page_id to get the same numbers for one page. Pages table Total Crawls for one page: filter by web_page_id and sum count across all rows (every platform and crawl type). Date range: as on the Agent Analytics tab, requests stamped exactly 00:00:00 on the day after end_date are included and returned as a row dated that next day. Drop rows dated after end_date to match the Pages table exactly.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
brand_kit_idintegerRequired

The Brand Kit ID

Body
brand_kit_idintegerRequired

The ID of the Brand Kit

start_datestringOptional

Start date (ISO 8601), inclusive. Defaults to 1 month ago.

end_datestringOptional

End date (ISO 8601), inclusive. Defaults to today. As on the Agent Analytics tab, requests stamped exactly 00:00:00 the next day are also included, dated that next day.

sortstring · enumOptional

Sort field. Prefix with - for descending.

Available sort fields:

  • date/-date: Sort by date
  • count/-count: Sort by request count. Use -count for the largest first.
Default: datePossible values:
pageintegerOptional

Page number

Default: 1
per_pageinteger · max: 100Optional

Items per page

Default: 25
Responses
200

Successful response

application/json
post/public_api/brand_kits/{brand_kit_id}/agent_analytics/list
POST /public_api/brand_kits/{brand_kit_id}/agent_analytics/list HTTP/1.1
Host: api.airops.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 177

{
  "brand_kit_id": 1,
  "start_date": "text",
  "end_date": "text",
  "filters": [
    {
      "field": "platform",
      "operator": "EQUALS",
      "value": null
    }
  ],
  "fields": [
    "date"
  ],
  "sort": "date",
  "page": 1,
  "per_page": 25
}
{
  "data": [
    {
      "date": "text",
      "platform": "text",
      "crawl_type": "text",
      "count": 1
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 1,
    "total_count": 1,
    "total_pages": 1,
    "start_date": "text",
    "end_date": "text"
  }
}

Last updated

Was this helpful?