Gaps & citations
List citation sources
https://api.vidrys.com/v1/projects/{project_id}/citations- Plan
- Grow and above
- Key
- read
- Rate cost
- 1 unit
- MCP tool
- list_citation_sources
Gaps & citations
https://api.vidrys.com/v1/projects/{project_id}/citationsSent as a header on every request.
AuthorizationstringrequiredA Vidrys API key, sent as Bearer vidrys_sk_…. A read key is enough. See Authentication.
project_idstringrequiredThe project's id, from List projects.
pageintegerdefault 1Page number, from 1.
page_sizeintegerdefault 50Rows per page, 1–100.
application/json
domainsobject[]Cited domains, the ones behind the most lost prompts first.
domainstringThe domain, without www..
kindstringWhose it is. A domain can appear once per kind.
Values:owncompetitorthird_party
citationsintegerCited URLs on this domain.
lost_promptsintegerPrompts where an answer cited it and the brand lost.
trendobject[]Cumulative citations by kind at each snapshot, oldest first.
datestringDay, as YYYY-MM-DD.
ownintegerCitations of the brand's domains, running total.
competitorintegerCitations of competitors' domains, running total.
third_partyintegerCitations of other domains, running total.
pageobjectWhere these rows sit in the full list.
pageintegerThis page's number, from 1.
page_sizeintegerRows per page.
totalintegerRows across every page.
| 404 not_found | The project or item doesn't exist in this workspace. A project from another workspace also returns 404, never 403. |
| 422 invalid_request | A parameter or body field is missing or has the wrong type or value. The message names the field. Also returned when a write would pass the plan's prompt limit. |
| 401 unauthorized | No key was sent, or the key is unknown, revoked or expired, or the member who created it has left the workspace or been deactivated. |
| 402 plan_required | The workspace's plan doesn't include API access. It's included on Grow, Scale and Custom. |
| 403 workspace_not_approved | The workspace is still waiting for approval, or wasn't approved. |
| 429 rate_limited | Too many requests this minute. Wait for the number of seconds in the `Retry-After` header, then retry. |
Every code, and what to retry, is in Errors.