Export AI chatbot events

GET

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

const url = 'https://hitkeep.com/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/ai-chatbots/export?format=xlsx&scope_key=provider';
const options = {method: 'GET', headers: {cookie: 'hk_token=<hk_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://hitkeep.com/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/ai-chatbots/export?format=xlsx&scope_key=provider' \
  --cookie hk_token=<hk_token>

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.

Authorizations

Parameters

Path Parameters

required

string format: uuid

Query Parameters

from

string format: date-time

format

string

Allowed values: xlsx csv parquet json ndjson

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

filter

string

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

scope_key

string

Allowed values: provider bot_id surface model

Optional chatbot scope filter key.

scope_value

string

Optional chatbot scope filter value. Requires scope_key.

Responses

200

Export file stream