Skip to content
ansvra.Documentation
Reports
Reports

Read competitors report

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

GET/projects/{projectId}/reports/competitors
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.

Competitor reporting must be enabled for this project.

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

platformstringOptional

One saved platform.

categoryIdstringOptional

Category identifier.

promptIdstringOptional

Prompt identifier.

runIdstringOptional

Run identifier.

promptTypestringOptional

nonbranded, branded or all.

Default: nonbranded

pageintegerOptional

Page, starting at 1.

Default: 1

pageSizeintegerOptional

Rows per page, 1–100.

Default: 20

Response fields

dataobjectRequired

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

Child fields
scopestringOptional

Resolved reporting period, filters and history boundaries.

filtersobjectOptional

Saved filters for this report or view.

Child fields
promptTypestringOptional

Saved prompt type for this report or view.

pagenumberOptional

Current page, starting at 1.

pageSizenumberOptional

Rows per page.

definitionsobjectOptional

Saved definitions for this report or view.

Child fields
citationRatestringOptional

Saved citation rate for this report or view.

mentionRatestringOptional

Saved mention rate for this report or view.

citationSharestringOptional

Saved citation share for this report or view.

historystringOptional

Saved history for this report or view.

trendstringOptional

Saved trend for this report or view.

projectobjectOptional

Saved project for this report or view.

Child fields
idstringOptional

Saved id for this report or view.

workspaceIdstringOptional

Saved workspace id for this report or view.

archivedbooleanOptional

Saved archived for this report or view.

namestringOptional

Saved name for this report or view.

domainstringOptional

Saved domain for this report or view.

websiteUrlvalue | nullOptional

Saved website url for this report or view.

brandReportLogovalue | nullOptional

Saved brand report logo for this report or view.

marketstringOptional

Saved market for this report or view.

targetStatevalue | nullOptional

Saved target state for this report or view.

languagestringOptional

Saved language for this report or view.

brandAliasesarrayOptional

Saved brand aliases for this report or view.

domainAliasesarrayOptional

Saved domain aliases for this report or view.

includeSubdomainsbooleanOptional

Saved include subdomains for this report or view.

competitorAnalysisEnabledbooleanOptional

Saved competitor analysis enabled for this report or view.

scheduledChecksEnabledbooleanOptional

Saved scheduled checks enabled for this report or view.

automaticEmailsEnabledbooleanOptional

Saved automatic emails enabled for this report or view.

growthSettingsobjectOptional

Saved growth settings for this report or view.

growthStateobjectOptional

Saved growth state for this report or view.

weeklybooleanOptional

Saved weekly for this report or view.

nextRunAtvalue | nullOptional

Saved next run at for this report or view.

createdAtstringOptional

Saved created at for this report or view.

profileCorrectionsobjectOptional

Saved profile corrections for this report or view.

competitorsarrayOptional

Saved competitors for this report or view.

Child fields
idstringOptional

Saved id for this report or view.

projectIdstringOptional

Saved project id for this report or view.

namestringOptional

Saved name for this report or view.

domainstringOptional

Saved domain for this report or view.

domainAliasesarrayOptional

Saved domain aliases for this report or view.

brandAliasesarrayOptional

Saved brand aliases for this report or view.

archivedbooleanOptional

Saved archived for this report or view.

createdAtstringOptional

Saved created at for this report or view.

updatedAtstringOptional

Saved updated at for this report or view.

conflictsarrayOptional

Saved conflicts for this report or view.

rowsarrayOptional

Rows in this report’s current view.

Child fields
idstringOptional

Saved id for this report or view.

namestringOptional

Saved name for this report or view.

domainstringOptional

Saved domain for this report or view.

domainsarrayOptional

Saved domains for this report or view.

brandAliasesarrayOptional

Saved brand aliases for this report or view.

ownbooleanOptional

Saved own for this report or view.

includeSubdomainsbooleanOptional

Saved include subdomains for this report or view.

usablenumberOptional

Number of usable saved answers in the resolved scope.

citednumberOptional

Saved cited for this report or view.

mentionednumberOptional

Saved mentioned for this report or view.

citationRatenumberOptional

Saved citation rate for this report or view.

mentionRatevalue | nullOptional

Saved mention rate for this report or view.

pagesnumberOptional

Saved pages for this report or view.

citedEvidencearrayOptional

Saved cited evidence for this report or view.

mentionEvidencearrayOptional

Saved mention evidence for this report or view.

citationSharevalue | nullOptional

Saved citation share for this report or view.

platformsarrayOptional

Saved platforms for this report or view.

Child fields
idstringOptional

Saved id for this report or view.

namestringOptional

Saved name for this report or view.

rowsarrayOptional

Rows in this report’s current view.

Child fields
idstringOptional

Saved id for this report or view.

namestringOptional

Saved name for this report or view.

domainstringOptional

Saved domain for this report or view.

domainsarrayOptional

Saved domains for this report or view.

brandAliasesarrayOptional

Saved brand aliases for this report or view.

ownbooleanOptional

Saved own for this report or view.

includeSubdomainsbooleanOptional

Saved include subdomains for this report or view.

usablenumberOptional

Number of usable saved answers in the resolved scope.

citednumberOptional

Saved cited for this report or view.

mentionednumberOptional

Saved mentioned for this report or view.

citationRatenumberOptional

Saved citation rate for this report or view.

mentionRatevalue | nullOptional

Saved mention rate for this report or view.

pagesnumberOptional

Saved pages for this report or view.

citedEvidencearrayOptional

Saved cited evidence for this report or view.

mentionEvidencearrayOptional

Saved mention evidence for this report or view.

categoriesarrayOptional

Saved categories for this report or view.

Child fields
idstringOptional

Saved id for this report or view.

namestringOptional

Saved name for this report or view.

rowsarrayOptional

Rows in this report’s current view.

Child fields
idstringOptional

Saved id for this report or view.

namestringOptional

Saved name for this report or view.

domainstringOptional

Saved domain for this report or view.

domainsarrayOptional

Saved domains for this report or view.

brandAliasesarrayOptional

Saved brand aliases for this report or view.

ownbooleanOptional

Saved own for this report or view.

includeSubdomainsbooleanOptional

Saved include subdomains for this report or view.

usablenumberOptional

Number of usable saved answers in the resolved scope.

citednumberOptional

Saved cited for this report or view.

mentionednumberOptional

Saved mentioned for this report or view.

citationRatenumberOptional

Saved citation rate for this report or view.

mentionRatevalue | nullOptional

Saved mention rate for this report or view.

pagesnumberOptional

Saved pages for this report or view.

citedEvidencearrayOptional

Saved cited evidence for this report or view.

mentionEvidencearrayOptional

Saved mention evidence for this report or view.

pairwisearrayOptional

Saved pairwise for this report or view.

Child fields
idstringOptional

Saved id for this report or view.

namestringOptional

Saved name for this report or view.

ownOnlyarrayOptional

Saved own only for this report or view.

competitorOnlyarrayOptional

Saved competitor only for this report or view.

botharrayOptional

Saved both for this report or view.

neitherarrayOptional

Saved neither for this report or view.

Child fields
idstringOptional

Saved id for this report or view.

promptIdstringOptional

Saved prompt id for this report or view.

promptstringOptional

Saved prompt for this report or view.

platformstringOptional

Saved platform for this report or view.

runIdstringOptional

Saved run id for this report or view.

datestringOptional

Saved date for this report or view.

trendarrayOptional

Saved trend for this report or view.

Child fields
runIdstringOptional

Saved run id for this report or view.

datestringOptional

Saved date for this report or view.

usablenumberOptional

Number of usable saved answers in the resolved scope.

rowsarrayOptional

Rows in this report’s current view.

Child fields
idstringOptional

Saved id for this report or view.

namestringOptional

Saved name for this report or view.

domainstringOptional

Saved domain for this report or view.

domainsarrayOptional

Saved domains for this report or view.

brandAliasesarrayOptional

Saved brand aliases for this report or view.

ownbooleanOptional

Saved own for this report or view.

includeSubdomainsbooleanOptional

Saved include subdomains for this report or view.

usablenumberOptional

Number of usable saved answers in the resolved scope.

citednumberOptional

Saved cited for this report or view.

mentionednumberOptional

Saved mentioned for this report or view.

citationRatenumberOptional

Saved citation rate for this report or view.

mentionRatevalue | nullOptional

Saved mention rate for this report or view.

pagesnumberOptional

Saved pages for this report or view.

citedEvidencearrayOptional

Saved cited evidence for this report or view.

mentionEvidencearrayOptional

Saved mention evidence for this report or view.

comparisonarrayOptional

Saved comparison for this report or view.

Child fields
idstringOptional

Saved id for this report or view.

currentvalue | nullOptional

Saved current for this report or view.

previousvalue | nullOptional

Saved previous for this report or view.

currentSamplenumberOptional

Saved current sample for this report or view.

previousSamplenumberOptional

Saved previous sample for this report or view.

changevalue | nullOptional

Saved change for this report or view.

usablenumberOptional

Number of usable saved answers in the resolved scope.

diagnosticsnumberOptional

Saved diagnostics for this report or view.

limitedbooleanOptional

Saved limited for this report or view.

evidencearrayOptional

Saved evidence for this report or view.

Child fields
idstringOptional

Saved id for this report or view.

promptIdstringOptional

Saved prompt id for this report or view.

promptstringOptional

Saved prompt for this report or view.

platformstringOptional

Saved platform for this report or view.

runIdstringOptional

Saved run id for this report or view.

datestringOptional

Saved date for this report or view.

gapsarrayOptional

Saved gaps for this report or view.

pagesarrayOptional

Saved pages for this report or view.

optionsobjectOptional

Saved options for this report or view.

Child fields
historicalPlatformsarrayOptional

Saved historical platforms for this report or view.

promptsarrayOptional

Saved prompts for this report or view.

Child fields
followUpsarrayOptional

Saved follow ups for this report or view.

intentstringOptional

Saved intent for this report or view.

idstringOptional

Saved id for this report or view.

projectIdstringOptional

Saved project id for this report or view.

categoryIdstringOptional

Saved category id for this report or view.

textstringOptional

Saved text for this report or view.

marketstringOptional

Saved market for this report or view.

languagestringOptional

Saved language for this report or view.

brandedbooleanOptional

Saved branded for this report or view.

activebooleanOptional

Saved active for this report or view.

archivedbooleanOptional

Saved archived for this report or view.

provenancestringOptional

Saved provenance for this report or view.

metadataobjectOptional

Saved metadata for this report or view.

targetUrlvalue | nullOptional

Saved target url for this report or view.

targetConfirmedAtvalue | nullOptional

Saved target confirmed at for this report or view.

createdAtstringOptional

Saved created at for this report or view.

categoriesarrayOptional

Saved categories for this report or view.

Child fields
idstringOptional

Saved id for this report or view.

projectIdstringOptional

Saved project id for this report or view.

namestringOptional

Saved name for this report or view.

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.

gapTotalnumberOptional

Saved gap total for this report or view.

pageTotalnumberOptional

Saved page total for this report or view.

metaobjectRequired

Request metadata. Present on JSON success responses.

Child fields
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…