Sites

Export AI chatbot events

Exports AI chatbot instrumentation events for the selected site and date range in csv/xlsx/parquet/json/ndjson. Optional scope filters restrict the export to a single provider, bot, surface, or model. Repeatable hit-dimension filters restrict the export to matching audience sessions.

get/api/sites/{id}/ai-chatbots/export

Request

  • Base URL: https://demo.hitkeep.com
  • URL: https://demo.hitkeep.com/api/sites/{id}/ai-chatbots/export
  • Auth: one of:
    • API key in cookie hk_token
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring uuid required

Query parameters

fromstring date-time
tostring date-time
format'xlsx' | 'csv' | 'parquet' | 'json' | 'ndjson'

Export format. Supported values: xlsx, csv, parquet, json, ndjson. Defaults: xlsx for takeout endpoints, csv for hits export endpoints.

filterstring

Filter in form type:value (repeatable). Supported types: path, hostname, referrer, referrer_host, device, country, city, provider, asn, browser, language, ai_bot, ai_bot_category, ai_source, utm_campaign, utm_content, utm_medium, utm_source, utm_term, qr_code_id.

scope_key'provider' | 'bot_id' | 'surface' | 'model'

Optional chatbot scope filter key.

scope_valuestring

Optional chatbot scope filter value. Requires scope_key.

Response

Export file stream

Changes

No recorded changes to this operation across all 1 revision of this API.