Sites

Get AI activity report

Returns the unified AI activity report for a site: one merged view over tracked AI hits (classified at query time from the user agent and referrer) and server-log AI fetch records. Every count is tracked hits plus fetch records, and each row keeps the provenance split. Repeatable filter=type:value params narrow both sides where the dimension exists on both: ai_bot maps to the fetch assistant name, ai_bot_category to the fetch assistant category (falling back to the agent name for records ingested before that column existed), and path to both. An ai_source filter excludes the fetch side outright because fetch records carry no referrer, while hit-only dimensions such as country or device leave the fetch side unrestricted. The pageviews denominator applies the non-AI filters only. Repeatable goal_id and funnel_id parameters select session cohorts for tracked hits, pageviews, series, and comparison windows; fetch records are never cohort-filtered.

get/api/sites/{id}/ai-activity

Request

  • Base URL: https://demo.hitkeep.com
  • URL: https://demo.hitkeep.com/api/sites/{id}/ai-activity
  • 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
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.

filter_typestring
filter_valuestring
goal_idstring[]

Repeatable goal definition UUID used to select matching-session cohorts.

funnel_idstring[]

Repeatable funnel definition UUID used to select first-step session cohorts.

compare_fromstring date-time

Start of an optional comparison window. Malformed values are ignored rather than rejected.

compare_tostring date-time

End of an optional comparison window.

Response

AI activity report

ai_requestsinteger
error_rate_4xxnumber
error_rate_5xxnumber
fetch_countinteger
median_response_msinteger
pageviewsinteger

Total hits for the range under the non-AI filters only, so the AI share of a segment stays comparable while an AI dimension is drilled into.

paths_crawledinteger

Distinct paths seen on either side, counted before the top-list cap.

referral_visitsinteger

Distinct sessions referred by a known AI surface across the whole range.

top_agents_by_categoryobject

Merged agent top list per AI agent category, keyed by category.

total_bytesinteger
tracked_hitsinteger
unique_agentsinteger

Changes

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