Gaps & citations

List citation sources

The domains AI answers lean on for your prompts — yours, competitors', and everyone else's — ranked by how many prompts they cost you.
GEThttps://api.vidrys.com/v1/projects/{project_id}/citations
Plan
Grow and above
Key
read
Rate cost
1 unit

Authorization

Sent as a header on every request.

Authorizationstringrequired

A Vidrys API key, sent as Bearer vidrys_sk_…. A read key is enough. See Authentication.

Path parameters

project_idstringrequired

The project's id, from List projects.

Query parameters

pageintegerdefault 1

Page number, from 1.

page_sizeintegerdefault 50

Rows per page, 1–100.

Response · 200

application/json

domainsobject[]

Cited domains, the ones behind the most lost prompts first.

+Show child attributes
domainstring

The domain, without www..

kindstring

Whose it is. A domain can appear once per kind.

Values:owncompetitorthird_party

citationsinteger

Cited URLs on this domain.

lost_promptsinteger

Prompts where an answer cited it and the brand lost.

trendobject[]

Cumulative citations by kind at each snapshot, oldest first.

+Show child attributes
datestring

Day, as YYYY-MM-DD.

owninteger

Citations of the brand's domains, running total.

competitorinteger

Citations of competitors' domains, running total.

third_partyinteger

Citations of other domains, running total.

pageobject

Where these rows sit in the full list.

+Show child attributes
pageinteger

This page's number, from 1.

page_sizeinteger

Rows per page.

totalinteger

Rows across every page.

Errors

404 not_foundThe project or item doesn't exist in this workspace. A project from another workspace also returns 404, never 403.
422 invalid_requestA 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 unauthorizedNo 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_requiredThe workspace's plan doesn't include API access. It's included on Grow, Scale and Custom.
403 workspace_not_approvedThe workspace is still waiting for approval, or wasn't approved.
429 rate_limitedToo 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.