Read competitor
Read one saved record from competitors.
GET
/projects/{projectId}/competitors/{id}Required permission
data:readThe key must include this project and its owner must still have access.
Competitor reporting must be enabled for this project.
Authentication and permissions · Errors and limitsAuthorization
Authorizationstring · headerRequiredBearer access key. Never put a key in the URL.
Path parameters
projectIdstringRequiredProject identifier from List projects.
idstringRequiredIdentifier from the corresponding resource list.
Response fields
dataobjectRequiredRead one saved record from competitors.
Child fields
idstringRequiredUnique identifier for this record.
projectIdstringRequiredProject that owns this record.
namestringRequiredSaved name.
domainstringRequiredSaved domain.
domainAliasesJSONRequiredSaved domain aliases.
brandAliasesJSONRequiredSaved brand aliases.
archivedbooleanRequiredSaved archived.
createdAtISO 8601 timestampRequiredWhen this record was saved, in UTC.
updatedAtISO 8601 timestampRequiredWhen this record last changed, in UTC.
metaobjectRequiredRequest metadata. Present on JSON success responses.
Child fields
requestIdstringRequiredRequest identifier to include when contacting support.
resultScope"saved"RequiredSaved customer information; excludes Overview preview results.