Visibility API
Retrieve AI visibility scores, snapshots, and mention data.
GET
Returns visibility snapshots for your workspace, most recent first.
{
"data": [
{
"id": "6868b4c1f2a3b4c5d6e7f8a9",
"brandId": "6868b4c1f2a3b4c5d6e7f8a1",
"score": 71,
"delta": 3,
"engines": ["gpt", "perplexity", "claude", "gemini"],
"createdAt": "2026-06-12T09:41:00.000Z"
}
],
"pagination": { "hasMore": false, "nextCursor": null }
}
Fields are returned exactly as stored — score and delta are workspace-level visibility metrics, not per-engine breakdowns. There is no separate /scores or /snapshots sub-path; this single endpoint covers both current and historical values via the period filter.
POST
Trigger a manual scan across all configured engines.
Requires scans:write scope. Counts against your daily scan limit.
{
"data": {
"scanBatchId": "scn_01hw...",
"status": "running",
"promptCount": 34,
"engines": ["gpt", "perplexity"],
"estimatedCompletionAt": "2026-06-12T09:51:00.000Z"
}
}
Poll for completion or use the scan.completed webhook.
Next steps
Was this page helpful?Report an issue →