Read competitors report
Read competitors from saved information using the same reporting services as the app. No new collection is started.
/projects/{projectId}/reports/competitorsdata:readThe 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 limitsAuthorization
Authorizationstring · headerRequiredBearer access key. Never put a key in the URL.
Path parameters
projectIdstringRequiredProject identifier from List projects.
Query parameters
platformstringOptionalOne saved platform.
categoryIdstringOptionalCategory identifier.
promptIdstringOptionalPrompt identifier.
runIdstringOptionalRun identifier.
promptTypestringOptionalnonbranded, branded or all.
Default:
nonbrandedpageintegerOptionalPage, starting at 1.
Default:
1pageSizeintegerOptionalRows per page, 1–100.
Default:
20
Response fields
dataobjectRequiredRead competitors from saved information using the same reporting services as the app. No new collection is started.
Child fields
scopestringOptionalResolved reporting period, filters and history boundaries.
filtersobjectOptionalSaved filters for this report or view.
Child fields
promptTypestringOptionalSaved prompt type for this report or view.
pagenumberOptionalCurrent page, starting at 1.
pageSizenumberOptionalRows per page.
definitionsobjectOptionalSaved definitions for this report or view.
Child fields
citationRatestringOptionalSaved citation rate for this report or view.
mentionRatestringOptionalSaved mention rate for this report or view.
citationSharestringOptionalSaved citation share for this report or view.
historystringOptionalSaved history for this report or view.
trendstringOptionalSaved trend for this report or view.
projectobjectOptionalSaved project for this report or view.
Child fields
idstringOptionalSaved id for this report or view.
workspaceIdstringOptionalSaved workspace id for this report or view.
archivedbooleanOptionalSaved archived for this report or view.
namestringOptionalSaved name for this report or view.
domainstringOptionalSaved domain for this report or view.
websiteUrlvalue | nullOptionalSaved website url for this report or view.
brandReportLogovalue | nullOptionalSaved brand report logo for this report or view.
marketstringOptionalSaved market for this report or view.
targetStatevalue | nullOptionalSaved target state for this report or view.
languagestringOptionalSaved language for this report or view.
brandAliasesarrayOptionalSaved brand aliases for this report or view.
domainAliasesarrayOptionalSaved domain aliases for this report or view.
includeSubdomainsbooleanOptionalSaved include subdomains for this report or view.
competitorAnalysisEnabledbooleanOptionalSaved competitor analysis enabled for this report or view.
scheduledChecksEnabledbooleanOptionalSaved scheduled checks enabled for this report or view.
automaticEmailsEnabledbooleanOptionalSaved automatic emails enabled for this report or view.
growthSettingsobjectOptionalSaved growth settings for this report or view.
growthStateobjectOptionalSaved growth state for this report or view.
weeklybooleanOptionalSaved weekly for this report or view.
nextRunAtvalue | nullOptionalSaved next run at for this report or view.
createdAtstringOptionalSaved created at for this report or view.
profileCorrectionsobjectOptionalSaved profile corrections for this report or view.
competitorsarrayOptionalSaved competitors for this report or view.
Child fields
idstringOptionalSaved id for this report or view.
projectIdstringOptionalSaved project id for this report or view.
namestringOptionalSaved name for this report or view.
domainstringOptionalSaved domain for this report or view.
domainAliasesarrayOptionalSaved domain aliases for this report or view.
brandAliasesarrayOptionalSaved brand aliases for this report or view.
archivedbooleanOptionalSaved archived for this report or view.
createdAtstringOptionalSaved created at for this report or view.
updatedAtstringOptionalSaved updated at for this report or view.
conflictsarrayOptionalSaved conflicts for this report or view.
rowsarrayOptionalRows in this report’s current view.
Child fields
idstringOptionalSaved id for this report or view.
namestringOptionalSaved name for this report or view.
domainstringOptionalSaved domain for this report or view.
domainsarrayOptionalSaved domains for this report or view.
brandAliasesarrayOptionalSaved brand aliases for this report or view.
ownbooleanOptionalSaved own for this report or view.
includeSubdomainsbooleanOptionalSaved include subdomains for this report or view.
usablenumberOptionalNumber of usable saved answers in the resolved scope.
citednumberOptionalSaved cited for this report or view.
mentionednumberOptionalSaved mentioned for this report or view.
citationRatenumberOptionalSaved citation rate for this report or view.
mentionRatevalue | nullOptionalSaved mention rate for this report or view.
pagesnumberOptionalSaved pages for this report or view.
citedEvidencearrayOptionalSaved cited evidence for this report or view.
mentionEvidencearrayOptionalSaved mention evidence for this report or view.
citationSharevalue | nullOptionalSaved citation share for this report or view.
platformsarrayOptionalSaved platforms for this report or view.
Child fields
idstringOptionalSaved id for this report or view.
namestringOptionalSaved name for this report or view.
rowsarrayOptionalRows in this report’s current view.
Child fields
idstringOptionalSaved id for this report or view.
namestringOptionalSaved name for this report or view.
domainstringOptionalSaved domain for this report or view.
domainsarrayOptionalSaved domains for this report or view.
brandAliasesarrayOptionalSaved brand aliases for this report or view.
ownbooleanOptionalSaved own for this report or view.
includeSubdomainsbooleanOptionalSaved include subdomains for this report or view.
usablenumberOptionalNumber of usable saved answers in the resolved scope.
citednumberOptionalSaved cited for this report or view.
mentionednumberOptionalSaved mentioned for this report or view.
citationRatenumberOptionalSaved citation rate for this report or view.
mentionRatevalue | nullOptionalSaved mention rate for this report or view.
pagesnumberOptionalSaved pages for this report or view.
citedEvidencearrayOptionalSaved cited evidence for this report or view.
mentionEvidencearrayOptionalSaved mention evidence for this report or view.
categoriesarrayOptionalSaved categories for this report or view.
Child fields
idstringOptionalSaved id for this report or view.
namestringOptionalSaved name for this report or view.
rowsarrayOptionalRows in this report’s current view.
Child fields
idstringOptionalSaved id for this report or view.
namestringOptionalSaved name for this report or view.
domainstringOptionalSaved domain for this report or view.
domainsarrayOptionalSaved domains for this report or view.
brandAliasesarrayOptionalSaved brand aliases for this report or view.
ownbooleanOptionalSaved own for this report or view.
includeSubdomainsbooleanOptionalSaved include subdomains for this report or view.
usablenumberOptionalNumber of usable saved answers in the resolved scope.
citednumberOptionalSaved cited for this report or view.
mentionednumberOptionalSaved mentioned for this report or view.
citationRatenumberOptionalSaved citation rate for this report or view.
mentionRatevalue | nullOptionalSaved mention rate for this report or view.
pagesnumberOptionalSaved pages for this report or view.
citedEvidencearrayOptionalSaved cited evidence for this report or view.
mentionEvidencearrayOptionalSaved mention evidence for this report or view.
pairwisearrayOptionalSaved pairwise for this report or view.
Child fields
idstringOptionalSaved id for this report or view.
namestringOptionalSaved name for this report or view.
ownOnlyarrayOptionalSaved own only for this report or view.
competitorOnlyarrayOptionalSaved competitor only for this report or view.
botharrayOptionalSaved both for this report or view.
neitherarrayOptionalSaved neither for this report or view.
Child fields
idstringOptionalSaved id for this report or view.
promptIdstringOptionalSaved prompt id for this report or view.
promptstringOptionalSaved prompt for this report or view.
platformstringOptionalSaved platform for this report or view.
runIdstringOptionalSaved run id for this report or view.
datestringOptionalSaved date for this report or view.
trendarrayOptionalSaved trend for this report or view.
Child fields
runIdstringOptionalSaved run id for this report or view.
datestringOptionalSaved date for this report or view.
usablenumberOptionalNumber of usable saved answers in the resolved scope.
rowsarrayOptionalRows in this report’s current view.
Child fields
idstringOptionalSaved id for this report or view.
namestringOptionalSaved name for this report or view.
domainstringOptionalSaved domain for this report or view.
domainsarrayOptionalSaved domains for this report or view.
brandAliasesarrayOptionalSaved brand aliases for this report or view.
ownbooleanOptionalSaved own for this report or view.
includeSubdomainsbooleanOptionalSaved include subdomains for this report or view.
usablenumberOptionalNumber of usable saved answers in the resolved scope.
citednumberOptionalSaved cited for this report or view.
mentionednumberOptionalSaved mentioned for this report or view.
citationRatenumberOptionalSaved citation rate for this report or view.
mentionRatevalue | nullOptionalSaved mention rate for this report or view.
pagesnumberOptionalSaved pages for this report or view.
citedEvidencearrayOptionalSaved cited evidence for this report or view.
mentionEvidencearrayOptionalSaved mention evidence for this report or view.
comparisonarrayOptionalSaved comparison for this report or view.
Child fields
idstringOptionalSaved id for this report or view.
currentvalue | nullOptionalSaved current for this report or view.
previousvalue | nullOptionalSaved previous for this report or view.
currentSamplenumberOptionalSaved current sample for this report or view.
previousSamplenumberOptionalSaved previous sample for this report or view.
changevalue | nullOptionalSaved change for this report or view.
usablenumberOptionalNumber of usable saved answers in the resolved scope.
diagnosticsnumberOptionalSaved diagnostics for this report or view.
limitedbooleanOptionalSaved limited for this report or view.
evidencearrayOptionalSaved evidence for this report or view.
Child fields
idstringOptionalSaved id for this report or view.
promptIdstringOptionalSaved prompt id for this report or view.
promptstringOptionalSaved prompt for this report or view.
platformstringOptionalSaved platform for this report or view.
runIdstringOptionalSaved run id for this report or view.
datestringOptionalSaved date for this report or view.
gapsarrayOptionalSaved gaps for this report or view.
pagesarrayOptionalSaved pages for this report or view.
optionsobjectOptionalSaved options for this report or view.
Child fields
historicalPlatformsarrayOptionalSaved historical platforms for this report or view.
promptsarrayOptionalSaved prompts for this report or view.
Child fields
followUpsarrayOptionalSaved follow ups for this report or view.
intentstringOptionalSaved intent for this report or view.
idstringOptionalSaved id for this report or view.
projectIdstringOptionalSaved project id for this report or view.
categoryIdstringOptionalSaved category id for this report or view.
textstringOptionalSaved text for this report or view.
marketstringOptionalSaved market for this report or view.
languagestringOptionalSaved language for this report or view.
brandedbooleanOptionalSaved branded for this report or view.
activebooleanOptionalSaved active for this report or view.
archivedbooleanOptionalSaved archived for this report or view.
provenancestringOptionalSaved provenance for this report or view.
metadataobjectOptionalSaved metadata for this report or view.
targetUrlvalue | nullOptionalSaved target url for this report or view.
targetConfirmedAtvalue | nullOptionalSaved target confirmed at for this report or view.
createdAtstringOptionalSaved created at for this report or view.
categoriesarrayOptionalSaved categories for this report or view.
Child fields
idstringOptionalSaved id for this report or view.
projectIdstringOptionalSaved project id for this report or view.
namestringOptionalSaved name for this report or view.
runsarrayOptionalSaved runs for this report or view.
Child fields
idstringOptionalSaved id for this report or view.
datestringOptionalSaved date for this report or view.
gapTotalnumberOptionalSaved gap total for this report or view.
pageTotalnumberOptionalSaved page total for this report or view.
metaobjectRequiredRequest metadata. Present on JSON success responses.
Child fields
requestIdstringOptionalSaved request id for this report or view.
resultScopestringOptionalSaved result scope for this report or view.