Skip to content
ansvra.Documentation
Reports
Reports

Read citations report

Read citations from saved information using the same reporting services as the app. No new collection is started.

GET/projects/{projectId}/reports/citations
Required permission data:read

The key must include this project and its owner must still have access.

Report response structures vary by report type and available saved evidence. Dates default to the report’s recent reporting window.

Response examples use fictional saved information. Repeated array entries are shortened for readability; full responses contain all entries for the requested view or page. Null measurements mean unavailable, not zero.

Authentication and permissions · Errors and limits

Authorization

Authorizationstring · headerRequired

Bearer access key. Never put a key in the URL.

Path parameters

projectIdstringRequired

Project identifier from List projects.

Query parameters

fromYYYY-MM-DDOptional

Inclusive start date. Supply to with it; at most 366 days.

toYYYY-MM-DDOptional

Inclusive end date. Supply from with it.

marketstringOptional

Filter saved citations by market.

languagestringOptional

Filter saved citations by language.

platformstring · repeatedOptional

Repeat this parameter for each platform.

categorystringOptional

Filter saved citations by category.

runIdstringOptional

Filter saved citations by runId.

searchstringOptional

Filter saved citations by search.

domainstringOptional

Filter saved citations by domain.

promptTypestringOptional

all, branded or discovery.

Default: all

ownershipstringOptional

all, own, competitor, other or unclassified.

Default: all

signalstringOptional

all, rising, new or gaps.

Default: all

viewstringOptional

pages or domains.

Default: pages

sortstringOptional

count, prompts, change, last or title.

Default: count

directionstringOptional

asc or desc.

Default: desc

pageintegerOptional

Page, starting at 1.

Default: 1

formatstringOptional

json or csv.

Default: json

Response fields

dataobjectRequired

Read citations from saved information using the same reporting services as the app. No new collection is started.

Child fields
reportingStartDatestringOptional

First day available in the account’s reporting history.

comparisonUnavailablebooleanOptional

Whether a comparable earlier reporting period is unavailable.

scopeobjectOptional

Resolved reporting period, filters and history boundaries.

Child fields
fromstringOptional

Saved from for this report or view.

tostringOptional

Saved to for this report or view.

marketstringOptional

Saved market for this report or view.

languagestringOptional

Saved language for this report or view.

platformsarrayOptional

Saved platforms for this report or view.

categorystringOptional

Saved category for this report or view.

promptTypestringOptional

Saved prompt type for this report or view.

runIdstringOptional

Saved run id for this report or view.

searchstringOptional

Saved search for this report or view.

ownershipstringOptional

Saved ownership for this report or view.

signalstringOptional

Saved signal for this report or view.

domainstringOptional

Saved domain for this report or view.

viewstringOptional

Saved view for this report or view.

sortstringOptional

Saved sort for this report or view.

directionstringOptional

Saved direction for this report or view.

pagenumberOptional

Current page, starting at 1.

formatstringOptional

Saved format for this report or view.

reportingStartDatestringOptional

First day available in the account’s reporting history.

historyUnavailablebooleanOptional

Saved history unavailable for this report or view.

timezonestringOptional

Saved timezone for this report or view.

previousFromstringOptional

Saved previous from for this report or view.

previousTostringOptional

Saved previous to for this report or view.

summaryobjectOptional

Saved summary for this report or view.

Child fields
usablenumberOptional

Number of usable saved answers in the resolved scope.

occurrencesnumberOptional

Saved occurrences for this report or view.

urlsnumberOptional

Saved urls for this report or view.

domainsnumberOptional

Saved domains for this report or view.

ownAnswersnumberOptional

Saved own answers for this report or view.

ownRatenumberOptional

Saved own rate for this report or view.

mixobjectOptional

Saved mix for this report or view.

Child fields
ownnumberOptional

Saved own for this report or view.

competitornumberOptional

Saved competitor for this report or view.

othernumberOptional

Saved other for this report or view.

unclassifiednumberOptional

Saved unclassified for this report or view.

activityarrayOptional

Saved activity for this report or view.

Child fields
datestringOptional

Saved date for this report or view.

samplesnumberOptional

Saved samples for this report or view.

openaivalue | nullOptional

Saved openai for this report or view.

claudevalue | nullOptional

Saved claude for this report or view.

perplexityvalue | nullOptional

Saved perplexity for this report or view.

google_overviewvalue | nullOptional

Saved google_overview for this report or view.

google_modevalue | nullOptional

Saved google_mode for this report or view.

geminivalue | nullOptional

Saved gemini for this report or view.

copilotvalue | nullOptional

Saved copilot for this report or view.

bing_modevalue | nullOptional

Saved bing_mode for this report or view.

comparisonobjectOptional

Saved comparison for this report or view.

Child fields
currentnumberOptional

Saved current for this report or view.

previousnumberOptional

Saved previous for this report or view.

cohortsnumberOptional

Saved cohorts for this report or view.

insightsobjectOptional

Saved insights for this report or view.

Child fields
risingnumberOptional

Saved rising for this report or view.

newnumberOptional

Saved new for this report or view.

gapsnumberOptional

Saved gaps for this report or view.

competitorEnabledbooleanOptional

Saved competitor enabled for this report or view.

hasPreviousbooleanOptional

Saved has previous for this report or view.

rowsarrayOptional

Rows in this report’s current view.

totalnumberOptional

Total matching entries before page slicing.

pagenumberOptional

Current page, starting at 1.

pageSizenumberOptional

Rows per page.

runsarrayOptional

Saved runs for this report or view.

Child fields
idstringOptional

Saved id for this report or view.

datestringOptional

Saved date for this report or view.

languagesarrayOptional

Saved languages for this report or view.

metaobjectRequired

Request metadata. Present on JSON success responses.

Child fields
scopeobjectOptional

Resolved reporting period, filters and history boundaries.

Child fields
fromstringOptional

Saved from for this report or view.

tostringOptional

Saved to for this report or view.

marketstringOptional

Saved market for this report or view.

languagestringOptional

Saved language for this report or view.

platformsarrayOptional

Saved platforms for this report or view.

categorystringOptional

Saved category for this report or view.

promptTypestringOptional

Saved prompt type for this report or view.

runIdstringOptional

Saved run id for this report or view.

searchstringOptional

Saved search for this report or view.

ownershipstringOptional

Saved ownership for this report or view.

signalstringOptional

Saved signal for this report or view.

domainstringOptional

Saved domain for this report or view.

viewstringOptional

Saved view for this report or view.

sortstringOptional

Saved sort for this report or view.

directionstringOptional

Saved direction for this report or view.

pagenumberOptional

Current page, starting at 1.

formatstringOptional

Saved format for this report or view.

reportingStartDatestringOptional

First day available in the account’s reporting history.

historyUnavailablebooleanOptional

Saved history unavailable for this report or view.

timezonestringOptional

Saved timezone for this report or view.

previousFromstringOptional

Saved previous from for this report or view.

previousTostringOptional

Saved previous to for this report or view.

requestIdstringOptional

Saved request id for this report or view.

resultScopestringOptional

Saved result scope for this report or view.

Ansvra

A clearer next step.

MEET YOUR AI GUIDE

A little clarity.
A clearer next move.

Ask about Ansvra, AI visibility, or your next step with content.

Opening chat…