Get search and AI visibility
Returns how search engines and AI tools find your publication: visits referred by search engines and AI assistants (ChatGPT, Perplexity, Claude, ...), pages fetched by AI crawlers, and the posts and pages they reach most. The same report as the Search & AI tab in the app's analytics.
AI crawler hits are only tracked on a live custom website; crawlerTrackingAvailable is false otherwise. This data isn't in the analytics SQL schema.
Periods: daily covers the last 14 days, weekly the last 12 weeks, monthly the last 12 months, and all all time by month.
apiKeyAuthorizationBearer <token>API key for authenticating protected endpoints. Pass as Bearer token in Authorization header.
period?stringReporting grain and window (default: daily, the last 14 days)
"daily""daily""weekly""monthly""all"Search and AI visibility report
application/json- response
period*stringReporting grain of the report
"daily""weekly""monthly""all"generatedAt*stringISO 8601 time the report was computed
crawlerTrackingAvailable*booleanWhether AI crawler hits can be tracked. Crawlers are only detected on a live custom website, so crawler fields are empty when this is false.
summary*Totals for the report window
series*array<>Search visits, AI visits, and crawler hits per time bucket
sources*array<>Visits per search engine and AI assistant
crawlers*array<>Hits per AI crawler
topContent*array<>Posts with the most search and AI-referred visits
topCrawledPaths*array<>Pages on the website most fetched by AI crawlers
curl -X GET "https://example.com/v1/analytics/search-ai"{ "period": "daily", "generatedAt": "string", "crawlerTrackingAvailable": true, "summary": { "searchVisits": 0, "aiVisits": 0, "crawlerHits": 0, "topSearchSource": "string", "topAiSource": "string", "topCrawler": "string" }, "series": [ { "bucketStart": "string", "searchVisits": 0, "aiVisits": 0, "crawlerHits": 0 } ], "sources": [ { "source": "string", "channel": "search", "visits": 0, "lastVisitAt": "string" } ], "crawlers": [ { "botName": "string", "operator": "string", "category": "training", "hits": 0, "lastHitAt": "string" } ], "topContent": [ { "postId": "string", "postTitle": "string", "searchVisits": 0, "aiVisits": 0 } ], "topCrawledPaths": [ { "path": "string", "hits": 0 } ]}Describe the analytics schema GET
Returns column metadata for every table and view in the analytics schema. Use this to discover available tables/columns before writing an analytics query.
List agents GET
Every agent available to your publication, what it can be configured with, and how yours is set up. Read this rather than hard-coding field keys: an agent describes its own settings, so a client built from this response keeps working as agents change.