citlyze docs
API

AI Crawler Events Resource

Export daily AI crawler visits captured from your tracked sites.

Daily counts of AI crawler visits (GPTBot, ClaudeBot, PerplexityBot, Bingbot, Amazonbot, and more) recorded from sites where you installed crawler tracking. Each row is one day's hit total for a single crawler on a single path.

Endpoint:

GET /api/v1/crawler-events

This resource is only populated once you install crawler tracking on a site (AI Crawlers → Install tracking). See AI Crawler Tracking for setup.

Filters

FilterMeaning
crawler_idRestrict to one crawler, e.g. gptbot, claudebot, perplexitybot, bingbot.
site_key_idRestrict to one tracked site.
sinceLower bound for event_date (ISO date).
untilUpper bound for event_date (ISO date).

Key fields

  • site_key_id — the tracked site the visit was recorded for
  • event_date — UTC day of the visits (YYYY-MM-DD)
  • crawler_id — stable crawler identifier (e.g. gptbot)
  • crawler_org — operating company (e.g. OpenAI)
  • path — the request path the crawler hit
  • hits — number of visits that day for this crawler + path

Example

curl -H "Authorization: Bearer $AEO_API_KEY" \
  "https://app.citlyze.com/api/v1/crawler-events?crawler_id=gptbot&since=2026-06-01"

CSV export is supported with ?format=csv. Rows are ordered by event_date (newest first); paginate with limit and offset.

Use this resource to chart AI crawler traffic over time, attribute visits to specific pages, and compare which engines crawl you most.

AI referrals

Human visits that arrived from an AI answer (ChatGPT, Perplexity, Gemini, Copilot, Claude, and others) are captured by the same tracking install and exposed at their own endpoint with the same parameters:

GET /api/v1/ai-referrals
ParameterMeaning
source_idRestrict to one AI source (e.g. referral_chatgpt).
site_key_idRestrict to one tracked site.
since / untilBounds for event_date (ISO date).

Rows carry source_id, source_org, path, and daily hits. Update your Cloudflare/Vercel snippet or the WordPress plugin to the latest version to start forwarding AI referrers; crawler-only installs keep working unchanged.

本页内容