{
"code": "invalid_cursor",
"detail": "The cursor is invalid or belongs to a different query.",
"instance": "example-request-id",
"status": 400,
"title": "Bad Request",
"type": "https://docs.heralded.ai/errors-and-limits#invalid_cursor"
}
{
"code": "invalid_token",
"detail": "The Authorization header carries no API key Heralded knows: it is missing, mistyped, revoked or expired.",
"instance": "example-request-id",
"status": 401,
"title": "Unauthorized",
"type": "https://docs.heralded.ai/errors-and-limits#invalid_token"
}
{
"code": "insufficient_scope",
"detail": "The credential does not have the scope this operation requires.",
"instance": "example-request-id",
"status": 403,
"title": "Forbidden",
"type": "https://docs.heralded.ai/errors-and-limits#insufficient_scope"
}
{
"code": "not_found",
"detail": "Nothing here that this API key can read.",
"instance": "example-request-id",
"status": 404,
"title": "Not Found",
"type": "https://docs.heralded.ai/errors-and-limits#not_found"
}
{
"code": "workspace_archived",
"detail": "The API key's organization is archived.",
"instance": "example-request-id",
"status": 409,
"title": "Conflict",
"type": "https://docs.heralded.ai/errors-and-limits#workspace_archived"
}
{
"code": "invalid_request",
"detail": "The request's parameters are invalid; `errors` names each one.",
"errors": [
{
"loc": [
"query",
"limit"
],
"msg": "Input should be less than or equal to 100",
"type": "less_than_equal"
}
],
"instance": "example-request-id",
"status": 422,
"title": "Unprocessable Content",
"type": "https://docs.heralded.ai/errors-and-limits#invalid_request"
}
{
"code": "rate_limited",
"detail": "This caller is past its requests for the minute. Retry after the seconds in Retry-After.",
"instance": "example-request-id",
"rate_limit": {
"limit": 120,
"remaining": 0,
"reset": 60,
"window": 60
},
"status": 429,
"title": "Too Many Requests",
"type": "https://docs.heralded.ai/errors-and-limits#rate_limited"
}
Visibility
Get Competitors
The brand and its rivals, ranked by Heralded Score on AI or Mentioned on Search.
with_page adds the competitor leaderboard and roster capacity.
with_details also includes weekly sites, moves and stored AI descriptions.
{
"code": "invalid_cursor",
"detail": "The cursor is invalid or belongs to a different query.",
"instance": "example-request-id",
"status": 400,
"title": "Bad Request",
"type": "https://docs.heralded.ai/errors-and-limits#invalid_cursor"
}
{
"code": "invalid_token",
"detail": "The Authorization header carries no API key Heralded knows: it is missing, mistyped, revoked or expired.",
"instance": "example-request-id",
"status": 401,
"title": "Unauthorized",
"type": "https://docs.heralded.ai/errors-and-limits#invalid_token"
}
{
"code": "insufficient_scope",
"detail": "The credential does not have the scope this operation requires.",
"instance": "example-request-id",
"status": 403,
"title": "Forbidden",
"type": "https://docs.heralded.ai/errors-and-limits#insufficient_scope"
}
{
"code": "not_found",
"detail": "Nothing here that this API key can read.",
"instance": "example-request-id",
"status": 404,
"title": "Not Found",
"type": "https://docs.heralded.ai/errors-and-limits#not_found"
}
{
"code": "workspace_archived",
"detail": "The API key's organization is archived.",
"instance": "example-request-id",
"status": 409,
"title": "Conflict",
"type": "https://docs.heralded.ai/errors-and-limits#workspace_archived"
}
{
"code": "invalid_request",
"detail": "The request's parameters are invalid; `errors` names each one.",
"errors": [
{
"loc": [
"query",
"limit"
],
"msg": "Input should be less than or equal to 100",
"type": "less_than_equal"
}
],
"instance": "example-request-id",
"status": 422,
"title": "Unprocessable Content",
"type": "https://docs.heralded.ai/errors-and-limits#invalid_request"
}
{
"code": "rate_limited",
"detail": "This caller is past its requests for the minute. Retry after the seconds in Retry-After.",
"instance": "example-request-id",
"rate_limit": {
"limit": 120,
"remaining": 0,
"reset": 60,
"window": 60
},
"status": 429,
"title": "Too Many Requests",
"type": "https://docs.heralded.ai/errors-and-limits#rate_limited"
}
Authorizations
serviceTokenapiKey
Authorization
string
header
required
An organisation service token, sent as Authorization: Bearer hrld_svc_... Scopes: scans:start starts service scans; scans:read reads them; managed:read reads brands, profile, overview, scores, competitors, actions and Snapshots in actively managed organisations; managed:share makes their restricted Snapshots unlisted.
Path Parameters
brand_id
string<uuid>
required
The brand's UUID from listBrands.
Query Parameters
country
string | null
Check country or global. Omit for all.
limit
integer
default:20
Maximum rows (100).
Required range: 1 <= x <= 100
cursor
string | null
Prior next_cursor; keep filters and limit.
Maximum string length: 4096
as_of
string<uuid> | null
Completed scan id cutoff.
offset
integer
default:0
Rows to skip; prefer cursor paging.
Required range: x >= 0
side
enum<string>
default:all
Read AI answers (ai), Google shares without a score (search), or AI figures (all).
Available options:
all,
ai,
search
market
string | null
Country ISO code, europe for pooled Europe, or global for no country. Omit for all.
audience
string<uuid>string
Audience UUID, or all_buyers for topics for all buyers. Omit for all.
engine
enum<string> | null
Answering AI engine.
Available options:
perplexity,
gemini,
openai,
google_aio,
ai_mode,
copilot,
claude
type
enum<string> | null
Question type.
Available options:
organic,
brand_specific,
competitor_comparison
intent
enum<string> | null
Question intent.
Available options:
educational,
problem,
comparison,
transactional
topic
string<uuid> | null
Tracked topic UUID.
prompt
string<uuid> | null
Question id from list_prompts.
period
enum<string>
default:1w
Weekly-report period.
Available options:
1w,
4w,
12w,
all
with_details
boolean
default:false
Include the page, weekly competitor sites and moves, and AI descriptions.
you
enum<string> | null
Keep prompts or answers matching this brand-presence state.
Available options:
named,
not_named
topic_id
string | null
Select a topic by id, or untagged for prompts without a topic.
Maximum string length: 100
with_page
boolean
default:false
Include competitor website details.
with_menus
boolean
default:false
Include available filter choices.
with_trend
boolean
default:true
Include each figure's weekly trend. Without it, trend is empty.
sort
enum<string> | null
Order the leaderboard by this figure. Defaults to Mentioned descending on Search, or Heralded Score descending on AI and All.
Available options:
brand,
score,
trend,
mentioned,
recommended,
product_cards
direction
enum<string> | null
Order results ascending or descending.
Available options:
asc,
desc
discovered_limit
integer
default:10
Maximum discovered competitors to return.
Required range: 1 <= x <= 100
discovered_offset
integer
default:0
Discovered competitors to skip.
Required range: x >= 0
Response
Successful Response
channels
V1Channel · object[]
required
Show child attributes
competitors
V1Competitor · object[]
required
Show child attributes
description_at
string<date-time> | null
required
When the report supplying the AI descriptions completed.
description_scan_id
string<uuid> | null
required
The report whose interpretation supplies the AI descriptions.
discovered
V1DiscoveredCompetitor · object[]
required
Show child attributes
headline
string | null
required
With details, the templated headline over the filtered leaderboard.
meta
Meta · object
required
Normalized query and newest included scan.
Show child attributes
next_cursor
string | null
required
Pass as cursor with the same query to read the next page; null at the end.
page
CompetitorsPage · object | null
required
Show child attributes
period
V1Period · object
required
Show child attributes
share_of_voice
V1ShareOfVoice · object
required
Show child attributes
sides_available
enum<string>[]
required
The sides the period's reports observed: ai, and search once a report checked keywords. A read of reports without search observations states ["ai"], and all is then the AI side.
Available options:
ai,
search
sites
V1CompetitorSites · object | null
required
Weekly site data and moves with with_details=true.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Heralded","colors":{"primary":"#8a6410","light":"#f0b545","dark":"#b57c1d"},"logo":{"light":"https://mintcdn.com/growth-path/c9JZqZZJeoekc9h3/logo/heralded-light.svg?fit=max\u0026auto=format\u0026n=c9JZqZZJeoekc9h3\u0026q=85\u0026s=348eea39d63635c9b888a413b15ada1e","dark":"https://mintcdn.com/growth-path/c9JZqZZJeoekc9h3/logo/heralded-dark.svg?fit=max\u0026auto=format\u0026n=c9JZqZZJeoekc9h3\u0026q=85\u0026s=6da1fdb0555f0bcf2ba9f09cf30452f3","href":"https://heralded.ai"},"favicon":"https://mintcdn.com/growth-path/ZSYm8Tfs8DiC_uz7/favicon.svg?fit=max\u0026auto=format\u0026n=ZSYm8Tfs8DiC_uz7\u0026q=85\u0026s=a0a11c94c0397741d9f04799b8d1d278","api":{"playground":{"display":"interactive"}},"background":{"decoration":"grid","color":{"light":"#f8f8f6","dark":"#10100f"}},"navbar":{"primary":{"type":"button","label":"Open Heralded","href":"https://app.heralded.ai"}},"footer":{"socials":{"website":"https://heralded.ai"}},"fonts":{"family":"Schibsted Grotesk"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"growth-path","hasAudioNarration":false,"actualSubdomain":"growth-path","customDomains":["docs.heralded.ai"],"gitSource":{"type":"github","owner":"growthpath-ai","repo":"heralded","deployBranch":"main","contentDirectory":"docs-site","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6b02c14293edbf63bed54c5b","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API reference","count":60},{"language":"default","tag":"Guides","count":34},{"language":"default","tag":"Methodology","count":22},{"language":"default","tag":"Visibility","count":19},{"language":"default","tag":"What Heralded measures","count":13},{"language":"default","tag":"Get started","count":11},{"language":"default","tag":"Actions","count":8},{"language":"default","tag":"Site","count":8},{"language":"default","tag":"Your workspace","count":7},{"language":"default","tag":"Developers","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"/* vietnamese */\n@font-face {\n font-family: 'Fraunces';\n font-style: normal;\n font-weight: 500 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/fraunces/v38/6NU78FyLNQOQZAnv9bYEvDiIdE9Ea92uemAk_WBq8U_9v0c2Wa0KxCBTeO-U.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Fraunces';\n font-style: normal;\n font-weight: 500 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/fraunces/v38/6NU78FyLNQOQZAnv9bYEvDiIdE9Ea92uemAk_WBq8U_9v0c2Wa0KxCFTeO-U.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Fraunces';\n font-style: normal;\n font-weight: 500 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/fraunces/v38/6NU78FyLNQOQZAnv9bYEvDiIdE9Ea92uemAk_WBq8U_9v0c2Wa0KxC9TeA.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n#page-title,#content h2,#content h3,#content h4{font-family:'Fraunces', Georgia, 'Times New Roman', serif;font-weight:600;letter-spacing:-0.01em}#topbar-cta-button a,#topbar-cta-button .text-white{color:#202018}#topbar-cta-button a>span:first-child{border-radius:9999px;background-color:#f0b545}#topbar-cta-button a:hover>span:first-child{background-color:#f6cf74;opacity:1}#topbar-cta-button a svg{color:#202018}#search-bar-entry{border-radius:9999px}.tryit-button,div:has(>div>.tryit-button),div:has(>div>.tryit-button)>div>:first-child{border-radius:9999px}"}]}
{"page":{"pagePath":"api-reference/v1/get-competitors","slug":"/api-reference/v1/get-competitors","pageMetadata":{"title":"Get Competitors","description":"The brand and its rivals, ranked by Heralded Score on AI or Mentioned on Search.\n\n`with_page` adds the competitor leaderboard and roster capacity.\n`with_details` also includes weekly sites, moves and stored AI descriptions.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/competitors","href":"/api-reference/v1/get-competitors","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"The brand and its rivals, ranked by Heralded Score on AI or Mentioned on Search.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"with_page\"\n }), \" adds the competitor leaderboard and roster capacity.\\n\", _jsx(_components.code, {\n children: \"with_details\"\n }), \" also includes weekly sites, moves and stored AI descriptions.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Competitors","description":"The brand and its rivals, ranked by Heralded Score on AI or Mentioned on Search.\n\n`with_page` adds the competitor leaderboard and roster capacity.\n`with_details` also includes weekly sites, moves and stored AI descriptions.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/competitors","href":"/api-reference/v1/get-competitors","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/growth-path/f6cffd90abc22b81/api-reference/functions/heralded.js"],"openApiReferenceData":{"operation":{"description":"The brand and its rivals, ranked by Heralded Score on AI or Mentioned on Search.\n\n`with_page` adds the competitor leaderboard and roster capacity.\n`with_details` also includes weekly sites, moves and stored AI descriptions.","operationId":"listCompetitors","parameters":["352dfd63-ab87-4b97-8d6d-4c4ab6f6e8b4","4c7ae0a6-cc7e-4246-be25-8c29050f95f7","bef1eed4-3dc4-40ba-a478-0bf26d26f7e0","e064f028-282a-4489-859a-13ad40f9e163","0fb72695-e2a1-46fc-871e-2b707d588884","7c784171-341b-415e-a062-2766fd96799b","858200ba-c63c-46b3-8312-e97c033e0eae","d99b4fa1-61be-49b1-aa27-4386223e7a67","f5e4517b-cc4d-4c33-a6d6-21cedbdf3547","d5a6ce9f-fbb0-41be-b2f5-572cf35a56da","bb7073cf-1500-4339-9f77-06042422f1c9","18a95ec5-17b3-4efc-919f-54c30973d337","9f59b285-8f44-409f-afb4-8a533396fbd2","d97e31d9-71d2-4f94-b02c-28db0a41f1eb","99604d0a-fd8a-4e6d-8483-09ee9a157cee","e309cd4e-13fc-4aa7-aaed-4549ef7058c7","675ca155-0999-4d93-ab28-d604b3144529","04cf827b-ae4b-4634-a828-3fa7ff93dea3","2b7c3fb4-3041-4c93-934f-bb8a885f7cdd","8932fc78-776e-4f00-bb17-2a4d9197c3fb","0a708b02-7fdd-41d6-aab4-097319a5c978","1d4bb673-547f-41c1-b864-c29a15f88835","c5194c92-09bd-4016-b86b-3e1c1895818b","2d5ae984-a921-4934-b4a0-bbf47acb7057","3899a466-8ae1-4f11-a965-14d55bfc0d29"],"responses":{"200":"6545594b-41ec-471e-bc59-de8657d72d8d","400":"45eec2ef-a662-4ff6-ba55-1d35218499d1","401":"154a5d75-7ab5-4569-a5d5-d77e2937d843","403":"63b72461-8ebe-4297-b0fa-4e7dd960a3e5","404":"091e673c-8657-45bf-b0fb-52dcd35a092d","409":"b8a7e1c5-6f2b-4cf9-a065-3567ed190b07","422":"0627edb3-ef51-4784-8a42-c6225cf2e20a","429":"c50221ef-61ad-436e-a541-ff694b86fade"},"security":["4f3ee64e-eba2-4214-93dc-e94778ec97e2","9b43d9e0-cb08-45a9-9e52-c1e4cfa8cc26"],"summary":"Get Competitors","tags":["v1"],"method":"get","type":"path","servers":["2a6c7223-f392-4ed2-a23e-e38a17bdf9a0"],"path":"/v1/brands/{brand_id}/competitors","baseUrlOptions":["https://api.heralded.ai"],"title":"Get Competitors","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"352dfd63-ab87-4b97-8d6d-4c4ab6f6e8b4":{"description":"The brand's UUID from listBrands.","in":"path","name":"brand_id","required":true,"schema":{"description":"The brand's UUID from listBrands.","format":"uuid","title":"Brand Id","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}},"4c7ae0a6-cc7e-4246-be25-8c29050f95f7":{"description":"Check country or global. Omit for all.","in":"query","name":"country","required":false,"schema":{"oneOf":[{"type":"string","title":"Country","description":"Check country or global. Omit for all.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Country","description":"Check country or global. Omit for all.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"bef1eed4-3dc4-40ba-a478-0bf26d26f7e0":{"description":"Maximum rows (100).","in":"query","name":"limit","required":false,"schema":{"default":20,"description":"Maximum rows (100).","maximum":100,"minimum":1,"title":"Limit","type":"integer","isRequired":false,"uniqueKey":"","typeLabel":"integer"}},"e064f028-282a-4489-859a-13ad40f9e163":{"description":"Prior next_cursor; keep filters and limit.","in":"query","name":"cursor","required":false,"schema":{"oneOf":[{"type":"string","title":"Cursor","description":"Prior next_cursor; keep filters and limit.","maxLength":4096,"uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Cursor","description":"Prior next_cursor; keep filters and limit.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"0fb72695-e2a1-46fc-871e-2b707d588884":{"description":"Completed scan id cutoff.","in":"query","name":"as_of","required":false,"schema":{"oneOf":[{"type":"string","title":"As Of","description":"Completed scan id cutoff.","format":"uuid","uniqueKey":"oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"As Of","description":"Completed scan id cutoff.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid> | null"}},"7c784171-341b-415e-a062-2766fd96799b":{"description":"Rows to skip; prefer cursor paging.","in":"query","name":"offset","required":false,"schema":{"default":0,"description":"Rows to skip; prefer cursor paging.","minimum":0,"title":"Offset","type":"integer","isRequired":false,"uniqueKey":"","typeLabel":"integer"}},"858200ba-c63c-46b3-8312-e97c033e0eae":{"description":"Read AI answers (ai), Google shares without a score (search), or AI figures (all).","in":"query","name":"side","required":false,"schema":{"default":"all","description":"Read AI answers (ai), Google shares without a score (search), or AI figures (all).","enum":["all","ai","search"],"title":"Side","type":"string","isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"}},"d99b4fa1-61be-49b1-aa27-4386223e7a67":{"description":"Country ISO code, europe for pooled Europe, or global for no country. Omit for all.","in":"query","name":"market","required":false,"schema":{"oneOf":[{"type":"string","title":"Market","description":"Country ISO code, europe for pooled Europe, or global for no country. Omit for all.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Market","description":"Country ISO code, europe for pooled Europe, or global for no country. Omit for all.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"f5e4517b-cc4d-4c33-a6d6-21cedbdf3547":{"description":"Audience UUID, or all_buyers for topics for all buyers. Omit for all.","in":"query","name":"audience","required":false,"schema":{"oneOf":[{"type":"string","title":"Audience","description":"Audience UUID, or all_buyers for topics for all buyers. Omit for all.","format":"uuid","uniqueKey":"oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"string","title":"Audience","description":"Audience UUID, or all_buyers for topics for all buyers. Omit for all.","const":"all_buyers","uniqueKey":"oneOf.1","typeLabel":"string"},{"type":"null","title":"Audience","description":"Audience UUID, or all_buyers for topics for all buyers. Omit for all.","uniqueKey":"oneOf.2","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid> | string | null"}},"d5a6ce9f-fbb0-41be-b2f5-572cf35a56da":{"description":"Answering AI engine.","in":"query","name":"engine","required":false,"schema":{"oneOf":[{"type":"string","title":"Engine","description":"Answering AI engine.","enum":["perplexity","gemini","openai","google_aio","ai_mode","copilot","claude"],"uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Engine","description":"Answering AI engine.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring> | null"}},"bb7073cf-1500-4339-9f77-06042422f1c9":{"description":"Question type.","in":"query","name":"type","required":false,"schema":{"oneOf":[{"type":"string","title":"Type","description":"Question type.","enum":["organic","brand_specific","competitor_comparison"],"uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Type","description":"Question type.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring> | null"}},"18a95ec5-17b3-4efc-919f-54c30973d337":{"description":"Question intent.","in":"query","name":"intent","required":false,"schema":{"oneOf":[{"type":"string","title":"Intent","description":"Question intent.","enum":["educational","problem","comparison","transactional"],"uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Intent","description":"Question intent.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring> | null"}},"9f59b285-8f44-409f-afb4-8a533396fbd2":{"description":"Tracked topic UUID.","in":"query","name":"topic","required":false,"schema":{"oneOf":[{"type":"string","title":"Topic","description":"Tracked topic UUID.","format":"uuid","uniqueKey":"oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Topic","description":"Tracked topic UUID.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid> | null"}},"d97e31d9-71d2-4f94-b02c-28db0a41f1eb":{"description":"Question id from list_prompts.","in":"query","name":"prompt","required":false,"schema":{"oneOf":[{"type":"string","title":"Prompt","description":"Question id from list_prompts.","format":"uuid","uniqueKey":"oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Prompt","description":"Question id from list_prompts.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid> | null"}},"99604d0a-fd8a-4e6d-8483-09ee9a157cee":{"description":"Weekly-report period.","in":"query","name":"period","required":false,"schema":{"default":"1w","description":"Weekly-report period.","enum":["1w","4w","12w","all"],"title":"Period","type":"string","isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"}},"e309cd4e-13fc-4aa7-aaed-4549ef7058c7":{"description":"Include the page, weekly competitor sites and moves, and AI descriptions.","in":"query","name":"with_details","required":false,"schema":{"default":false,"description":"Include the page, weekly competitor sites and moves, and AI descriptions.","title":"With Details","type":"boolean","isRequired":false,"uniqueKey":"","typeLabel":"boolean"}},"675ca155-0999-4d93-ab28-d604b3144529":{"description":"Keep prompts or answers matching this brand-presence state.","in":"query","name":"you","required":false,"schema":{"oneOf":[{"type":"string","title":"You","description":"Keep prompts or answers matching this brand-presence state.","enum":["named","not_named"],"uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"You","description":"Keep prompts or answers matching this brand-presence state.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring> | null"}},"04cf827b-ae4b-4634-a828-3fa7ff93dea3":{"description":"Select a topic by id, or untagged for prompts without a topic.","in":"query","name":"topic_id","required":false,"schema":{"oneOf":[{"type":"string","title":"Topic Id","description":"Select a topic by id, or untagged for prompts without a topic.","maxLength":100,"uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Topic Id","description":"Select a topic by id, or untagged for prompts without a topic.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"2b7c3fb4-3041-4c93-934f-bb8a885f7cdd":{"description":"Include competitor website details.","in":"query","name":"with_page","required":false,"schema":{"default":false,"description":"Include competitor website details.","title":"With Page","type":"boolean","isRequired":false,"uniqueKey":"","typeLabel":"boolean"}},"8932fc78-776e-4f00-bb17-2a4d9197c3fb":{"description":"Include available filter choices.","in":"query","name":"with_menus","required":false,"schema":{"default":false,"description":"Include available filter choices.","title":"With Menus","type":"boolean","isRequired":false,"uniqueKey":"","typeLabel":"boolean"}},"0a708b02-7fdd-41d6-aab4-097319a5c978":{"description":"Include each figure's weekly trend. Without it, `trend` is empty.","in":"query","name":"with_trend","required":false,"schema":{"default":true,"description":"Include each figure's weekly trend. Without it, `trend` is empty.","title":"With Trend","type":"boolean","isRequired":false,"uniqueKey":"","typeLabel":"boolean"}},"1d4bb673-547f-41c1-b864-c29a15f88835":{"description":"Order the leaderboard by this figure. Defaults to Mentioned descending on Search, or Heralded Score descending on AI and All.","in":"query","name":"sort","required":false,"schema":{"oneOf":[{"type":"string","title":"Sort","description":"Order the leaderboard by this figure. Defaults to Mentioned descending on Search, or Heralded Score descending on AI and All.","enum":["brand","score","trend","mentioned","recommended","product_cards"],"uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Sort","description":"Order the leaderboard by this figure. Defaults to Mentioned descending on Search, or Heralded Score descending on AI and All.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring> | null"}},"c5194c92-09bd-4016-b86b-3e1c1895818b":{"description":"Order results ascending or descending.","in":"query","name":"direction","required":false,"schema":{"oneOf":[{"type":"string","title":"Direction","description":"Order results ascending or descending.","enum":["asc","desc"],"uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Direction","description":"Order results ascending or descending.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring> | null"}},"2d5ae984-a921-4934-b4a0-bbf47acb7057":{"description":"Maximum discovered competitors to return.","in":"query","name":"discovered_limit","required":false,"schema":{"default":10,"description":"Maximum discovered competitors to return.","maximum":100,"minimum":1,"title":"Discovered Limit","type":"integer","isRequired":false,"uniqueKey":"","typeLabel":"integer"}},"3899a466-8ae1-4f11-a965-14d55bfc0d29":{"description":"Discovered competitors to skip.","in":"query","name":"discovered_offset","required":false,"schema":{"default":0,"description":"Discovered competitors to skip.","minimum":0,"title":"Discovered Offset","type":"integer","isRequired":false,"uniqueKey":"","typeLabel":"integer"}}},"responses":{"6545594b-41ec-471e-bc59-de8657d72d8d":{"content":{"application/json":{"schema":{"examples":[{"channels":[],"competitors":[],"description_at":null,"description_scan_id":null,"discovered":[],"headline":null,"meta":{"data_as_of":null,"last_attempt_failed":false,"partial":false,"query":{},"surfaces":{},"updating":false},"next_cursor":null,"page":null,"period":{"excluded_reports":0,"first_answer_at":null,"last_answer_at":null,"preset":"1w","reports":0},"share_of_voice":{"answers":0,"excluded_answers":0,"population":"all_answers","rows":[],"state":"measured"},"sides_available":[],"sites":null}],"properties":{"channels":{"items":{"properties":{"answers":{"title":"Answers","type":"integer","isRequired":true,"uniqueKey":"channels.items.[INDEX].answers","typeLabel":"integer"},"domain":{"oneOf":[{"type":"string","title":"Domain","isRequired":true,"uniqueKey":"channels.items.[INDEX].domain.oneOf.0","typeLabel":"string"},{"type":"null","title":"Domain","isRequired":true,"uniqueKey":"channels.items.[INDEX].domain.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"channels.items.[INDEX].domain","typeLabel":"string | null"},"mentioned":{"oneOf":[{"type":"integer","title":"Mentioned","isRequired":true,"uniqueKey":"channels.items.[INDEX].mentioned.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Mentioned","isRequired":true,"uniqueKey":"channels.items.[INDEX].mentioned.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"channels.items.[INDEX].mentioned","typeLabel":"integer | null"},"name":{"title":"Name","type":"string","isRequired":true,"uniqueKey":"channels.items.[INDEX].name","typeLabel":"string"},"prompts":{"title":"Prompts","type":"integer","isRequired":true,"uniqueKey":"channels.items.[INDEX].prompts","typeLabel":"integer"}},"required":["name","domain","mentioned","answers","prompts"],"title":"V1Channel","type":"object","uniqueKey":"channels.items.[INDEX]","typeLabel":"V1Channel · object"},"title":"Channels","type":"array","isRequired":true,"uniqueKey":"channels","typeLabel":"V1Channel · object[]"},"competitors":{"items":{"properties":{"brand_key":{"description":"The key that opens this competitor's read.","title":"Brand Key","type":"string","isRequired":true,"uniqueKey":"competitors.items.[INDEX].brand_key","typeLabel":"string"},"description":{"oneOf":[{"type":"string","title":"Description","description":"The latest stored AI description with with_details=true.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","description":"The latest stored AI description with with_details=true.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].description","typeLabel":"string | null"},"domain":{"oneOf":[{"type":"string","title":"Domain","isRequired":true,"uniqueKey":"competitors.items.[INDEX].domain.oneOf.0","typeLabel":"string"},{"type":"null","title":"Domain","isRequired":true,"uniqueKey":"competitors.items.[INDEX].domain.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].domain","typeLabel":"string | null"},"heralded_score":{"properties":{"answers":{"title":"Answers","type":"integer","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.answers","typeLabel":"integer"},"basis":{"default":"ai","description":"Evidence used by this figure.","enum":["ai","ai_and_web","search"],"title":"Basis","type":"string","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.basis","typeLabel":"enum\u003cstring>"},"change":{"oneOf":[{"type":"object","title":"V1Change","required":["state","delta","low","high","real","direction","baseline","cells_unpaired","compared_engines"],"properties":{"baseline":{"properties":{"first_answer_at":{"oneOf":[{"type":"string","title":"First Answer At","format":"date-time","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.baseline.first_answer_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"First Answer At","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.baseline.first_answer_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.baseline.first_answer_at","typeLabel":"string\u003cdate-time> | null"},"last_answer_at":{"oneOf":[{"type":"string","title":"Last Answer At","format":"date-time","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.baseline.last_answer_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Last Answer At","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.baseline.last_answer_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.baseline.last_answer_at","typeLabel":"string\u003cdate-time> | null"},"reports":{"title":"Reports","type":"integer","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.baseline.reports","typeLabel":"integer"}},"required":["reports","first_answer_at","last_answer_at"],"title":"V1Baseline","type":"object","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.baseline","typeLabel":"V1Baseline · object"},"cells_unpaired":{"title":"Cells Unpaired","type":"integer","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.cells_unpaired","typeLabel":"integer"},"compared_engines":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.compared_engines.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Compared Engines","description":"The engines `delta` was sized on, when the baseline report asked other engines than the current period. The value and the trend still include every engine asked. Null when the size is the move the trend draws.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.compared_engines.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Compared Engines","description":"The engines `delta` was sized on, when the baseline report asked other engines than the current period. The value and the trend still include every engine asked. Null when the size is the move the trend draws.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.compared_engines.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.compared_engines","typeLabel":"string[] | null"},"delta":{"oneOf":[{"type":"number","title":"Delta","description":"The move in points: the shown value minus the baseline's, both as the trend draws them, or both over `compared_engines` where it names engines. Null when the baseline has no value.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.delta.oneOf.0","typeLabel":"number"},{"type":"null","title":"Delta","description":"The move in points: the shown value minus the baseline's, both as the trend draws them, or both over `compared_engines` where it names engines. Null when the baseline has no value.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.delta.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.delta","typeLabel":"number | null"},"direction":{"enum":["up","down","steady"],"title":"Direction","type":"string","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.direction","typeLabel":"enum\u003cstring>"},"high":{"oneOf":[{"type":"number","title":"High","description":"The upper end of the paired test's 95% range for the move, in points.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.high.oneOf.0","typeLabel":"number"},{"type":"null","title":"High","description":"The upper end of the paired test's 95% range for the move, in points.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.high.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.high","typeLabel":"number | null"},"low":{"oneOf":[{"type":"number","title":"Low","description":"The lower end of the paired test's 95% range for the move, in points.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.low.oneOf.0","typeLabel":"number"},{"type":"null","title":"Low","description":"The lower end of the paired test's 95% range for the move, in points.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.low.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.low","typeLabel":"number | null"},"real":{"description":"Whether the paired test over the prompt × engine cells both reads measured says the figure moved. The state is up or down only when this is true and the move has the sign of `delta`; otherwise it is steady and carries the signed `delta`.","title":"Real","type":"boolean","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.real","typeLabel":"boolean"},"state":{"description":"The comparison state. A steady comparison is distinct from a first report, calibration or an incompatible baseline.","enum":["up","down","steady","calibrating","first_report","not_comparable"],"title":"State","type":"string","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0.state","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.0","typeLabel":"V1Change · object"},{"type":"null","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.change","typeLabel":"V1Change · object | null"},"denominator":{"oneOf":[{"type":"integer","title":"Denominator","description":"The figure denominator; null for a blended score.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.denominator.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Denominator","description":"The figure denominator; null for a blended score.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.denominator.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.denominator","typeLabel":"integer | null"},"high":{"oneOf":[{"type":"integer","title":"High","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.high.oneOf.0","typeLabel":"integer"},{"type":"null","title":"High","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.high.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.high","typeLabel":"integer | null"},"low":{"oneOf":[{"type":"integer","title":"Low","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.low.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Low","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.low.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.low","typeLabel":"integer | null"},"numerator":{"oneOf":[{"type":"number","title":"Numerator","description":"The figure numerator; null for a blended score.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.numerator.oneOf.0","typeLabel":"number"},{"type":"null","title":"Numerator","description":"The figure numerator; null for a blended score.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.numerator.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.numerator","typeLabel":"number | null"},"state":{"description":"pending means Search is awaiting its first measurement, with a null value. not_measured means no measurement is available. not_scored means the figure is intentionally not scored, even when its underlying shares are measured. These states have null values and never mean zero. New states may be added; handle unknown values gracefully.","title":"State","type":"string","x-extensible-enum":["measured","too_few_answers","calibrating","first_report","not_comparable","not_measured","pending","not_scored"],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.state","typeLabel":"string"},"trend":{"items":{"properties":{"answers":{"title":"Answers","type":"integer","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.trend.items.[INDEX].answers","typeLabel":"integer"},"at":{"format":"date-time","title":"At","type":"string","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.trend.items.[INDEX].at","typeLabel":"string\u003cdate-time>"},"break":{"oneOf":[{"type":"object","title":"TrendBreak","required":["at","parts","engines_added","engines_removed","comparable"],"properties":{"at":{"description":"Date of the new baseline.","format":"date","title":"At","type":"string","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.trend.items.[INDEX].break.oneOf.0.at","typeLabel":"string\u003cdate>"},"comparable":{"description":"Whether the changed instrument still permits comparison.","title":"Comparable","type":"boolean","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.trend.items.[INDEX].break.oneOf.0.comparable","typeLabel":"boolean"},"engines_added":{"description":"Engines added at this baseline.","items":{"type":"string","uniqueKey":"competitors.items.[INDEX].heralded_score.trend.items.[INDEX].break.oneOf.0.engines_added.items.[INDEX]","typeLabel":"string"},"title":"Engines Added","type":"array","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.trend.items.[INDEX].break.oneOf.0.engines_added","typeLabel":"string[]"},"engines_removed":{"description":"Engines removed at this baseline.","items":{"type":"string","uniqueKey":"competitors.items.[INDEX].heralded_score.trend.items.[INDEX].break.oneOf.0.engines_removed.items.[INDEX]","typeLabel":"string"},"title":"Engines Removed","type":"array","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.trend.items.[INDEX].break.oneOf.0.engines_removed","typeLabel":"string[]"},"parts":{"description":"Instrument parts that changed.","items":{"type":"string","x-extensible-enum":["engines","language","market","score_version","answer_pack_version","understood_measure","sells_to","shopping_pack_version"],"uniqueKey":"competitors.items.[INDEX].heralded_score.trend.items.[INDEX].break.oneOf.0.parts.items.[INDEX]","typeLabel":"string"},"title":"Parts","type":"array","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.trend.items.[INDEX].break.oneOf.0.parts","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.trend.items.[INDEX].break.oneOf.0","typeLabel":"TrendBreak · object"},{"type":"null","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.trend.items.[INDEX].break.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.trend.items.[INDEX].break","typeLabel":"TrendBreak · object | null"},"high":{"oneOf":[{"type":"integer","title":"High","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.trend.items.[INDEX].high.oneOf.0","typeLabel":"integer"},{"type":"null","title":"High","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.trend.items.[INDEX].high.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.trend.items.[INDEX].high","typeLabel":"integer | null"},"low":{"oneOf":[{"type":"integer","title":"Low","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.trend.items.[INDEX].low.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Low","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.trend.items.[INDEX].low.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.trend.items.[INDEX].low","typeLabel":"integer | null"},"state":{"title":"State","type":"string","x-extensible-enum":["measured","too_few_answers","calibrating","first_report","not_comparable","not_measured","pending","not_scored"],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.trend.items.[INDEX].state","typeLabel":"string"},"value":{"oneOf":[{"type":"integer","title":"Value","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.trend.items.[INDEX].value.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Value","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.trend.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.trend.items.[INDEX].value","typeLabel":"integer | null"}},"required":["at","value","low","high","answers","state","break"],"title":"V1TrendPoint","type":"object","uniqueKey":"competitors.items.[INDEX].heralded_score.trend.items.[INDEX]","typeLabel":"V1TrendPoint · object"},"title":"Trend","type":"array","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.trend","typeLabel":"V1TrendPoint · object[]"},"value":{"oneOf":[{"type":"integer","title":"Value","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.value.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Value","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score.value","typeLabel":"integer | null"}},"required":["basis","value","low","high","numerator","denominator","answers","state","change","trend"],"title":"V1Figure","type":"object","isRequired":true,"uniqueKey":"competitors.items.[INDEX].heralded_score","typeLabel":"V1Figure · object"},"is_you":{"title":"Is You","type":"boolean","isRequired":true,"uniqueKey":"competitors.items.[INDEX].is_you","typeLabel":"boolean"},"mentioned":{"properties":{"answers":{"title":"Answers","type":"integer","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.answers","typeLabel":"integer"},"basis":{"default":"ai","description":"Evidence used by this figure.","enum":["ai","ai_and_web","search"],"title":"Basis","type":"string","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.basis","typeLabel":"enum\u003cstring>"},"change":{"oneOf":[{"type":"object","title":"V1Change","required":["state","delta","low","high","real","direction","baseline","cells_unpaired","compared_engines"],"properties":{"baseline":{"properties":{"first_answer_at":{"oneOf":[{"type":"string","title":"First Answer At","format":"date-time","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.baseline.first_answer_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"First Answer At","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.baseline.first_answer_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.baseline.first_answer_at","typeLabel":"string\u003cdate-time> | null"},"last_answer_at":{"oneOf":[{"type":"string","title":"Last Answer At","format":"date-time","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.baseline.last_answer_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Last Answer At","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.baseline.last_answer_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.baseline.last_answer_at","typeLabel":"string\u003cdate-time> | null"},"reports":{"title":"Reports","type":"integer","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.baseline.reports","typeLabel":"integer"}},"required":["reports","first_answer_at","last_answer_at"],"title":"V1Baseline","type":"object","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.baseline","typeLabel":"V1Baseline · object"},"cells_unpaired":{"title":"Cells Unpaired","type":"integer","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.cells_unpaired","typeLabel":"integer"},"compared_engines":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.compared_engines.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Compared Engines","description":"The engines `delta` was sized on, when the baseline report asked other engines than the current period. The value and the trend still include every engine asked. Null when the size is the move the trend draws.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.compared_engines.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Compared Engines","description":"The engines `delta` was sized on, when the baseline report asked other engines than the current period. The value and the trend still include every engine asked. Null when the size is the move the trend draws.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.compared_engines.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.compared_engines","typeLabel":"string[] | null"},"delta":{"oneOf":[{"type":"number","title":"Delta","description":"The move in points: the shown value minus the baseline's, both as the trend draws them, or both over `compared_engines` where it names engines. Null when the baseline has no value.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.delta.oneOf.0","typeLabel":"number"},{"type":"null","title":"Delta","description":"The move in points: the shown value minus the baseline's, both as the trend draws them, or both over `compared_engines` where it names engines. Null when the baseline has no value.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.delta.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.delta","typeLabel":"number | null"},"direction":{"enum":["up","down","steady"],"title":"Direction","type":"string","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.direction","typeLabel":"enum\u003cstring>"},"high":{"oneOf":[{"type":"number","title":"High","description":"The upper end of the paired test's 95% range for the move, in points.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.high.oneOf.0","typeLabel":"number"},{"type":"null","title":"High","description":"The upper end of the paired test's 95% range for the move, in points.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.high.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.high","typeLabel":"number | null"},"low":{"oneOf":[{"type":"number","title":"Low","description":"The lower end of the paired test's 95% range for the move, in points.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.low.oneOf.0","typeLabel":"number"},{"type":"null","title":"Low","description":"The lower end of the paired test's 95% range for the move, in points.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.low.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.low","typeLabel":"number | null"},"real":{"description":"Whether the paired test over the prompt × engine cells both reads measured says the figure moved. The state is up or down only when this is true and the move has the sign of `delta`; otherwise it is steady and carries the signed `delta`.","title":"Real","type":"boolean","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.real","typeLabel":"boolean"},"state":{"description":"The comparison state. A steady comparison is distinct from a first report, calibration or an incompatible baseline.","enum":["up","down","steady","calibrating","first_report","not_comparable"],"title":"State","type":"string","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0.state","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.0","typeLabel":"V1Change · object"},{"type":"null","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.change","typeLabel":"V1Change · object | null"},"denominator":{"oneOf":[{"type":"integer","title":"Denominator","description":"The figure denominator; null for a blended score.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.denominator.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Denominator","description":"The figure denominator; null for a blended score.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.denominator.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.denominator","typeLabel":"integer | null"},"high":{"oneOf":[{"type":"integer","title":"High","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.high.oneOf.0","typeLabel":"integer"},{"type":"null","title":"High","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.high.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.high","typeLabel":"integer | null"},"low":{"oneOf":[{"type":"integer","title":"Low","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.low.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Low","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.low.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.low","typeLabel":"integer | null"},"numerator":{"oneOf":[{"type":"number","title":"Numerator","description":"The figure numerator; null for a blended score.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.numerator.oneOf.0","typeLabel":"number"},{"type":"null","title":"Numerator","description":"The figure numerator; null for a blended score.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.numerator.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.numerator","typeLabel":"number | null"},"state":{"description":"pending means Search is awaiting its first measurement, with a null value. not_measured means no measurement is available. not_scored means the figure is intentionally not scored, even when its underlying shares are measured. These states have null values and never mean zero. New states may be added; handle unknown values gracefully.","title":"State","type":"string","x-extensible-enum":["measured","too_few_answers","calibrating","first_report","not_comparable","not_measured","pending","not_scored"],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.state","typeLabel":"string"},"trend":{"items":{"properties":{"answers":{"title":"Answers","type":"integer","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.trend.items.[INDEX].answers","typeLabel":"integer"},"at":{"format":"date-time","title":"At","type":"string","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.trend.items.[INDEX].at","typeLabel":"string\u003cdate-time>"},"break":{"oneOf":[{"type":"object","title":"TrendBreak","required":["at","parts","engines_added","engines_removed","comparable"],"properties":{"at":{"description":"Date of the new baseline.","format":"date","title":"At","type":"string","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.trend.items.[INDEX].break.oneOf.0.at","typeLabel":"string\u003cdate>"},"comparable":{"description":"Whether the changed instrument still permits comparison.","title":"Comparable","type":"boolean","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.trend.items.[INDEX].break.oneOf.0.comparable","typeLabel":"boolean"},"engines_added":{"description":"Engines added at this baseline.","items":{"type":"string","uniqueKey":"competitors.items.[INDEX].mentioned.trend.items.[INDEX].break.oneOf.0.engines_added.items.[INDEX]","typeLabel":"string"},"title":"Engines Added","type":"array","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.trend.items.[INDEX].break.oneOf.0.engines_added","typeLabel":"string[]"},"engines_removed":{"description":"Engines removed at this baseline.","items":{"type":"string","uniqueKey":"competitors.items.[INDEX].mentioned.trend.items.[INDEX].break.oneOf.0.engines_removed.items.[INDEX]","typeLabel":"string"},"title":"Engines Removed","type":"array","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.trend.items.[INDEX].break.oneOf.0.engines_removed","typeLabel":"string[]"},"parts":{"description":"Instrument parts that changed.","items":{"type":"string","x-extensible-enum":["engines","language","market","score_version","answer_pack_version","understood_measure","sells_to","shopping_pack_version"],"uniqueKey":"competitors.items.[INDEX].mentioned.trend.items.[INDEX].break.oneOf.0.parts.items.[INDEX]","typeLabel":"string"},"title":"Parts","type":"array","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.trend.items.[INDEX].break.oneOf.0.parts","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.trend.items.[INDEX].break.oneOf.0","typeLabel":"TrendBreak · object"},{"type":"null","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.trend.items.[INDEX].break.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.trend.items.[INDEX].break","typeLabel":"TrendBreak · object | null"},"high":{"oneOf":[{"type":"integer","title":"High","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.trend.items.[INDEX].high.oneOf.0","typeLabel":"integer"},{"type":"null","title":"High","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.trend.items.[INDEX].high.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.trend.items.[INDEX].high","typeLabel":"integer | null"},"low":{"oneOf":[{"type":"integer","title":"Low","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.trend.items.[INDEX].low.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Low","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.trend.items.[INDEX].low.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.trend.items.[INDEX].low","typeLabel":"integer | null"},"state":{"title":"State","type":"string","x-extensible-enum":["measured","too_few_answers","calibrating","first_report","not_comparable","not_measured","pending","not_scored"],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.trend.items.[INDEX].state","typeLabel":"string"},"value":{"oneOf":[{"type":"integer","title":"Value","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.trend.items.[INDEX].value.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Value","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.trend.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.trend.items.[INDEX].value","typeLabel":"integer | null"}},"required":["at","value","low","high","answers","state","break"],"title":"V1TrendPoint","type":"object","uniqueKey":"competitors.items.[INDEX].mentioned.trend.items.[INDEX]","typeLabel":"V1TrendPoint · object"},"title":"Trend","type":"array","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.trend","typeLabel":"V1TrendPoint · object[]"},"value":{"oneOf":[{"type":"integer","title":"Value","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.value.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Value","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned.value","typeLabel":"integer | null"}},"required":["basis","value","low","high","numerator","denominator","answers","state","change","trend"],"title":"V1Figure","type":"object","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned","typeLabel":"V1Figure · object"},"mentioned_since":{"oneOf":[{"type":"string","title":"Mentioned Since","description":"Start of a shorter AI measurement population within the selected period.","format":"date-time","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned_since.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Mentioned Since","description":"Start of a shorter AI measurement population within the selected period.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned_since.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].mentioned_since","typeLabel":"string\u003cdate-time> | null"},"most_said_against":{"oneOf":[{"type":"string","title":"Most Said Against","description":"The competitor's negative opinion with the most holders in the period, as its label. Null for you and where none is held.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].most_said_against.oneOf.0","typeLabel":"string"},{"type":"null","title":"Most Said Against","description":"The competitor's negative opinion with the most holders in the period, as its label. Null for you and where none is held.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].most_said_against.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].most_said_against","typeLabel":"string | null"},"most_said_for":{"oneOf":[{"type":"string","title":"Most Said For","description":"The competitor's positive opinion with the most holders in the period, as its label. Null for you and where none is held. Filters do not narrow it.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].most_said_for.oneOf.0","typeLabel":"string"},{"type":"null","title":"Most Said For","description":"The competitor's positive opinion with the most holders in the period, as its label. Null for you and where none is held. Filters do not narrow it.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].most_said_for.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].most_said_for","typeLabel":"string | null"},"name":{"title":"Name","type":"string","isRequired":true,"uniqueKey":"competitors.items.[INDEX].name","typeLabel":"string"},"product_cards":{"oneOf":[{"type":"object","title":"BrandProductCards","description":"Product-card figures for ecommerce brands; null for other brands and Google search.","required":["weeks","state","in_product_cards","average_position","best_position"],"properties":{"average_position":{"oneOf":[{"type":"number","title":"Average Position","description":"Mean of each answer's best place for the brand.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].product_cards.oneOf.0.average_position.oneOf.0","typeLabel":"number"},{"type":"null","title":"Average Position","description":"Mean of each answer's best place for the brand.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].product_cards.oneOf.0.average_position.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].product_cards.oneOf.0.average_position","typeLabel":"number | null"},"best_position":{"oneOf":[{"type":"integer","title":"Best Position","description":"Lowest organic place for the brand.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].product_cards.oneOf.0.best_position.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Best Position","description":"Lowest organic place for the brand.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].product_cards.oneOf.0.best_position.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].product_cards.oneOf.0.best_position","typeLabel":"integer | null"},"in_product_cards":{"description":"Answers showing the brand divided by answers with organic cards.","properties":{"denominator":{"description":"The count it is a share of.","title":"Denominator","type":"integer","isRequired":true,"uniqueKey":"competitors.items.[INDEX].product_cards.oneOf.0.in_product_cards.denominator","typeLabel":"integer"},"high":{"oneOf":[{"type":"number","title":"High","description":"The 95% range's high end; null with no denominator.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].product_cards.oneOf.0.in_product_cards.high.oneOf.0","typeLabel":"number"},{"type":"null","title":"High","description":"The 95% range's high end; null with no denominator.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].product_cards.oneOf.0.in_product_cards.high.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].product_cards.oneOf.0.in_product_cards.high","typeLabel":"number | null"},"low":{"oneOf":[{"type":"number","title":"Low","description":"The 95% range's low end; null with no denominator.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].product_cards.oneOf.0.in_product_cards.low.oneOf.0","typeLabel":"number"},{"type":"null","title":"Low","description":"The 95% range's low end; null with no denominator.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].product_cards.oneOf.0.in_product_cards.low.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].product_cards.oneOf.0.in_product_cards.low","typeLabel":"number | null"},"numerator":{"description":"The figure's own count.","title":"Numerator","type":"integer","isRequired":true,"uniqueKey":"competitors.items.[INDEX].product_cards.oneOf.0.in_product_cards.numerator","typeLabel":"integer"},"value":{"oneOf":[{"type":"number","title":"Value","description":"The share in [0, 1]; null with no denominator.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].product_cards.oneOf.0.in_product_cards.value.oneOf.0","typeLabel":"number"},{"type":"null","title":"Value","description":"The share in [0, 1]; null with no denominator.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].product_cards.oneOf.0.in_product_cards.value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].product_cards.oneOf.0.in_product_cards.value","typeLabel":"number | null"}},"required":["value","low","high","numerator","denominator"],"title":"ShoppingShare","type":"object","isRequired":true,"uniqueKey":"competitors.items.[INDEX].product_cards.oneOf.0.in_product_cards","typeLabel":"ShoppingShare · object"},"state":{"description":"Whether the population's product cards were read.","enum":["read","not_read","not_measured"],"title":"State","type":"string","isRequired":true,"uniqueKey":"competitors.items.[INDEX].product_cards.oneOf.0.state","typeLabel":"enum\u003cstring>"},"weeks":{"default":0,"description":"Weekly reports counted from the period measured as ecommerce.","title":"Weeks","type":"integer","isRequired":true,"uniqueKey":"competitors.items.[INDEX].product_cards.oneOf.0.weeks","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"competitors.items.[INDEX].product_cards.oneOf.0","typeLabel":"BrandProductCards · object"},{"type":"null","description":"Product-card figures for ecommerce brands; null for other brands and Google search.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].product_cards.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].product_cards","typeLabel":"BrandProductCards · object | null"},"rank":{"oneOf":[{"type":"integer","title":"Rank","description":"The brand's place by Heralded Score on AI, or Mentioned in search on Google. Measured ties share a place; null for an unmeasured brand.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].rank.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Rank","description":"The brand's place by Heralded Score on AI, or Mentioned in search on Google. Measured ties share a place; null for an unmeasured brand.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].rank.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].rank","typeLabel":"integer | null"},"recommended":{"properties":{"answers":{"title":"Answers","type":"integer","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.answers","typeLabel":"integer"},"basis":{"default":"ai","description":"Evidence used by this figure.","enum":["ai","ai_and_web","search"],"title":"Basis","type":"string","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.basis","typeLabel":"enum\u003cstring>"},"change":{"oneOf":[{"type":"object","title":"V1Change","required":["state","delta","low","high","real","direction","baseline","cells_unpaired","compared_engines"],"properties":{"baseline":{"properties":{"first_answer_at":{"oneOf":[{"type":"string","title":"First Answer At","format":"date-time","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.baseline.first_answer_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"First Answer At","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.baseline.first_answer_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.baseline.first_answer_at","typeLabel":"string\u003cdate-time> | null"},"last_answer_at":{"oneOf":[{"type":"string","title":"Last Answer At","format":"date-time","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.baseline.last_answer_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Last Answer At","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.baseline.last_answer_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.baseline.last_answer_at","typeLabel":"string\u003cdate-time> | null"},"reports":{"title":"Reports","type":"integer","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.baseline.reports","typeLabel":"integer"}},"required":["reports","first_answer_at","last_answer_at"],"title":"V1Baseline","type":"object","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.baseline","typeLabel":"V1Baseline · object"},"cells_unpaired":{"title":"Cells Unpaired","type":"integer","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.cells_unpaired","typeLabel":"integer"},"compared_engines":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.compared_engines.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Compared Engines","description":"The engines `delta` was sized on, when the baseline report asked other engines than the current period. The value and the trend still include every engine asked. Null when the size is the move the trend draws.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.compared_engines.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Compared Engines","description":"The engines `delta` was sized on, when the baseline report asked other engines than the current period. The value and the trend still include every engine asked. Null when the size is the move the trend draws.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.compared_engines.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.compared_engines","typeLabel":"string[] | null"},"delta":{"oneOf":[{"type":"number","title":"Delta","description":"The move in points: the shown value minus the baseline's, both as the trend draws them, or both over `compared_engines` where it names engines. Null when the baseline has no value.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.delta.oneOf.0","typeLabel":"number"},{"type":"null","title":"Delta","description":"The move in points: the shown value minus the baseline's, both as the trend draws them, or both over `compared_engines` where it names engines. Null when the baseline has no value.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.delta.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.delta","typeLabel":"number | null"},"direction":{"enum":["up","down","steady"],"title":"Direction","type":"string","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.direction","typeLabel":"enum\u003cstring>"},"high":{"oneOf":[{"type":"number","title":"High","description":"The upper end of the paired test's 95% range for the move, in points.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.high.oneOf.0","typeLabel":"number"},{"type":"null","title":"High","description":"The upper end of the paired test's 95% range for the move, in points.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.high.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.high","typeLabel":"number | null"},"low":{"oneOf":[{"type":"number","title":"Low","description":"The lower end of the paired test's 95% range for the move, in points.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.low.oneOf.0","typeLabel":"number"},{"type":"null","title":"Low","description":"The lower end of the paired test's 95% range for the move, in points.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.low.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.low","typeLabel":"number | null"},"real":{"description":"Whether the paired test over the prompt × engine cells both reads measured says the figure moved. The state is up or down only when this is true and the move has the sign of `delta`; otherwise it is steady and carries the signed `delta`.","title":"Real","type":"boolean","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.real","typeLabel":"boolean"},"state":{"description":"The comparison state. A steady comparison is distinct from a first report, calibration or an incompatible baseline.","enum":["up","down","steady","calibrating","first_report","not_comparable"],"title":"State","type":"string","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0.state","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.0","typeLabel":"V1Change · object"},{"type":"null","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.change","typeLabel":"V1Change · object | null"},"denominator":{"oneOf":[{"type":"integer","title":"Denominator","description":"The figure denominator; null for a blended score.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.denominator.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Denominator","description":"The figure denominator; null for a blended score.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.denominator.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.denominator","typeLabel":"integer | null"},"high":{"oneOf":[{"type":"integer","title":"High","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.high.oneOf.0","typeLabel":"integer"},{"type":"null","title":"High","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.high.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.high","typeLabel":"integer | null"},"low":{"oneOf":[{"type":"integer","title":"Low","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.low.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Low","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.low.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.low","typeLabel":"integer | null"},"numerator":{"oneOf":[{"type":"number","title":"Numerator","description":"The figure numerator; null for a blended score.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.numerator.oneOf.0","typeLabel":"number"},{"type":"null","title":"Numerator","description":"The figure numerator; null for a blended score.","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.numerator.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.numerator","typeLabel":"number | null"},"state":{"description":"pending means Search is awaiting its first measurement, with a null value. not_measured means no measurement is available. not_scored means the figure is intentionally not scored, even when its underlying shares are measured. These states have null values and never mean zero. New states may be added; handle unknown values gracefully.","title":"State","type":"string","x-extensible-enum":["measured","too_few_answers","calibrating","first_report","not_comparable","not_measured","pending","not_scored"],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.state","typeLabel":"string"},"trend":{"items":{"properties":{"answers":{"title":"Answers","type":"integer","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.trend.items.[INDEX].answers","typeLabel":"integer"},"at":{"format":"date-time","title":"At","type":"string","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.trend.items.[INDEX].at","typeLabel":"string\u003cdate-time>"},"break":{"oneOf":[{"type":"object","title":"TrendBreak","required":["at","parts","engines_added","engines_removed","comparable"],"properties":{"at":{"description":"Date of the new baseline.","format":"date","title":"At","type":"string","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.trend.items.[INDEX].break.oneOf.0.at","typeLabel":"string\u003cdate>"},"comparable":{"description":"Whether the changed instrument still permits comparison.","title":"Comparable","type":"boolean","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.trend.items.[INDEX].break.oneOf.0.comparable","typeLabel":"boolean"},"engines_added":{"description":"Engines added at this baseline.","items":{"type":"string","uniqueKey":"competitors.items.[INDEX].recommended.trend.items.[INDEX].break.oneOf.0.engines_added.items.[INDEX]","typeLabel":"string"},"title":"Engines Added","type":"array","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.trend.items.[INDEX].break.oneOf.0.engines_added","typeLabel":"string[]"},"engines_removed":{"description":"Engines removed at this baseline.","items":{"type":"string","uniqueKey":"competitors.items.[INDEX].recommended.trend.items.[INDEX].break.oneOf.0.engines_removed.items.[INDEX]","typeLabel":"string"},"title":"Engines Removed","type":"array","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.trend.items.[INDEX].break.oneOf.0.engines_removed","typeLabel":"string[]"},"parts":{"description":"Instrument parts that changed.","items":{"type":"string","x-extensible-enum":["engines","language","market","score_version","answer_pack_version","understood_measure","sells_to","shopping_pack_version"],"uniqueKey":"competitors.items.[INDEX].recommended.trend.items.[INDEX].break.oneOf.0.parts.items.[INDEX]","typeLabel":"string"},"title":"Parts","type":"array","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.trend.items.[INDEX].break.oneOf.0.parts","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.trend.items.[INDEX].break.oneOf.0","typeLabel":"TrendBreak · object"},{"type":"null","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.trend.items.[INDEX].break.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.trend.items.[INDEX].break","typeLabel":"TrendBreak · object | null"},"high":{"oneOf":[{"type":"integer","title":"High","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.trend.items.[INDEX].high.oneOf.0","typeLabel":"integer"},{"type":"null","title":"High","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.trend.items.[INDEX].high.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.trend.items.[INDEX].high","typeLabel":"integer | null"},"low":{"oneOf":[{"type":"integer","title":"Low","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.trend.items.[INDEX].low.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Low","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.trend.items.[INDEX].low.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.trend.items.[INDEX].low","typeLabel":"integer | null"},"state":{"title":"State","type":"string","x-extensible-enum":["measured","too_few_answers","calibrating","first_report","not_comparable","not_measured","pending","not_scored"],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.trend.items.[INDEX].state","typeLabel":"string"},"value":{"oneOf":[{"type":"integer","title":"Value","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.trend.items.[INDEX].value.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Value","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.trend.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.trend.items.[INDEX].value","typeLabel":"integer | null"}},"required":["at","value","low","high","answers","state","break"],"title":"V1TrendPoint","type":"object","uniqueKey":"competitors.items.[INDEX].recommended.trend.items.[INDEX]","typeLabel":"V1TrendPoint · object"},"title":"Trend","type":"array","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.trend","typeLabel":"V1TrendPoint · object[]"},"value":{"oneOf":[{"type":"integer","title":"Value","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.value.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Value","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended.value","typeLabel":"integer | null"}},"required":["basis","value","low","high","numerator","denominator","answers","state","change","trend"],"title":"V1Figure","type":"object","isRequired":true,"uniqueKey":"competitors.items.[INDEX].recommended","typeLabel":"V1Figure · object"},"share_of_voice_pct":{"oneOf":[{"type":"number","title":"Share Of Voice Pct","isRequired":true,"uniqueKey":"competitors.items.[INDEX].share_of_voice_pct.oneOf.0","typeLabel":"number"},{"type":"null","title":"Share Of Voice Pct","isRequired":true,"uniqueKey":"competitors.items.[INDEX].share_of_voice_pct.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"competitors.items.[INDEX].share_of_voice_pct","typeLabel":"number | null"}},"required":["product_cards","brand_key","name","domain","is_you","rank","heralded_score","mentioned","recommended","share_of_voice_pct","mentioned_since","description","most_said_for","most_said_against"],"title":"V1Competitor","type":"object","uniqueKey":"competitors.items.[INDEX]","typeLabel":"V1Competitor · object"},"title":"Competitors","type":"array","isRequired":true,"uniqueKey":"competitors","typeLabel":"V1Competitor · object[]"},"description_at":{"oneOf":[{"type":"string","title":"Description At","description":"When the report supplying the AI descriptions completed.","format":"date-time","isRequired":true,"uniqueKey":"description_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Description At","description":"When the report supplying the AI descriptions completed.","isRequired":true,"uniqueKey":"description_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"description_at","typeLabel":"string\u003cdate-time> | null"},"description_scan_id":{"oneOf":[{"type":"string","title":"Description Scan Id","description":"The report whose interpretation supplies the AI descriptions.","format":"uuid","isRequired":true,"uniqueKey":"description_scan_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Description Scan Id","description":"The report whose interpretation supplies the AI descriptions.","isRequired":true,"uniqueKey":"description_scan_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"description_scan_id","typeLabel":"string\u003cuuid> | null"},"discovered":{"items":{"properties":{"answers":{"title":"Answers","type":"integer","isRequired":true,"uniqueKey":"discovered.items.[INDEX].answers","typeLabel":"integer"},"domain":{"oneOf":[{"type":"string","title":"Domain","isRequired":true,"uniqueKey":"discovered.items.[INDEX].domain.oneOf.0","typeLabel":"string"},{"type":"null","title":"Domain","isRequired":true,"uniqueKey":"discovered.items.[INDEX].domain.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"discovered.items.[INDEX].domain","typeLabel":"string | null"},"high":{"oneOf":[{"type":"integer","title":"High","isRequired":true,"uniqueKey":"discovered.items.[INDEX].high.oneOf.0","typeLabel":"integer"},{"type":"null","title":"High","isRequired":true,"uniqueKey":"discovered.items.[INDEX].high.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"discovered.items.[INDEX].high","typeLabel":"integer | null"},"low":{"oneOf":[{"type":"integer","title":"Low","isRequired":true,"uniqueKey":"discovered.items.[INDEX].low.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Low","isRequired":true,"uniqueKey":"discovered.items.[INDEX].low.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"discovered.items.[INDEX].low","typeLabel":"integer | null"},"name":{"title":"Name","type":"string","isRequired":true,"uniqueKey":"discovered.items.[INDEX].name","typeLabel":"string"},"state":{"title":"State","type":"string","x-extensible-enum":["measured","too_few_answers","calibrating","first_report","not_comparable","not_measured","pending","not_scored"],"isRequired":true,"uniqueKey":"discovered.items.[INDEX].state","typeLabel":"string"},"value":{"oneOf":[{"type":"integer","title":"Value","isRequired":true,"uniqueKey":"discovered.items.[INDEX].value.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Value","isRequired":true,"uniqueKey":"discovered.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"discovered.items.[INDEX].value","typeLabel":"integer | null"}},"required":["name","domain","value","low","high","answers","state"],"title":"V1DiscoveredCompetitor","type":"object","uniqueKey":"discovered.items.[INDEX]","typeLabel":"V1DiscoveredCompetitor · object"},"title":"Discovered","type":"array","isRequired":true,"uniqueKey":"discovered","typeLabel":"V1DiscoveredCompetitor · object[]"},"headline":{"oneOf":[{"type":"string","title":"Headline","description":"With details, the templated headline over the filtered leaderboard.","isRequired":true,"uniqueKey":"headline.oneOf.0","typeLabel":"string"},{"type":"null","title":"Headline","description":"With details, the templated headline over the filtered leaderboard.","isRequired":true,"uniqueKey":"headline.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"headline","typeLabel":"string | null"},"meta":{"properties":{"data_as_of":{"oneOf":[{"type":"object","title":"DataAsOf","required":["id","completed_at"],"properties":{"completed_at":{"format":"date-time","title":"Completed At","type":"string","isRequired":true,"uniqueKey":"meta.data_as_of.oneOf.0.completed_at","typeLabel":"string\u003cdate-time>"},"id":{"format":"uuid","title":"Id","type":"string","isRequired":true,"uniqueKey":"meta.data_as_of.oneOf.0.id","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"meta.data_as_of.oneOf.0","typeLabel":"DataAsOf · object"},{"type":"null","isRequired":true,"uniqueKey":"meta.data_as_of.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.data_as_of","typeLabel":"DataAsOf · object | null"},"last_attempt_failed":{"default":false,"description":"The newest attempt failed; the last good result is displayed.","title":"Last Attempt Failed","type":"boolean","isRequired":true,"uniqueKey":"meta.last_attempt_failed","typeLabel":"boolean"},"partial":{"default":false,"description":"The displayed response includes a partial report.","title":"Partial","type":"boolean","isRequired":true,"uniqueKey":"meta.partial","typeLabel":"boolean"},"query":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"meta.query.additionalProperties","typeLabel":"any"},"title":"Query","type":"object","isRequired":true,"uniqueKey":"meta.query","typeLabel":"Query · object"},"surfaces":{"additionalProperties":{"properties":{"as_of":{"oneOf":[{"type":"object","title":"SurfaceAsOf","description":"The result displayed here.","required":["scan_id","at"],"properties":{"at":{"description":"When the displayed result was measured.","format":"date-time","title":"At","type":"string","isRequired":true,"uniqueKey":"meta.surfaces.additionalProperties.as_of.oneOf.0.at","typeLabel":"string\u003cdate-time>"},"scan_id":{"oneOf":[{"type":"string","title":"Scan Id","description":"The result's scan, null for a timestamp-only result.","format":"uuid","isRequired":true,"uniqueKey":"meta.surfaces.additionalProperties.as_of.oneOf.0.scan_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Scan Id","description":"The result's scan, null for a timestamp-only result.","isRequired":true,"uniqueKey":"meta.surfaces.additionalProperties.as_of.oneOf.0.scan_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.surfaces.additionalProperties.as_of.oneOf.0.scan_id","typeLabel":"string\u003cuuid> | null"}},"isRequired":true,"uniqueKey":"meta.surfaces.additionalProperties.as_of.oneOf.0","typeLabel":"SurfaceAsOf · object"},{"type":"null","description":"The result displayed here.","isRequired":true,"uniqueKey":"meta.surfaces.additionalProperties.as_of.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.surfaces.additionalProperties.as_of","typeLabel":"SurfaceAsOf · object | null"},"last_attempt_failed":{"default":false,"description":"The newest attempt failed; any displayed result is retained.","title":"Last Attempt Failed","type":"boolean","isRequired":true,"uniqueKey":"meta.surfaces.additionalProperties.last_attempt_failed","typeLabel":"boolean"},"partial":{"default":false,"description":"The displayed report is partial.","title":"Partial","type":"boolean","isRequired":true,"uniqueKey":"meta.surfaces.additionalProperties.partial","typeLabel":"boolean"},"updating":{"default":false,"description":"A newer attempt exists whose result is not yet displayed.","title":"Updating","type":"boolean","isRequired":true,"uniqueKey":"meta.surfaces.additionalProperties.updating","typeLabel":"boolean"}},"required":["as_of","partial","updating","last_attempt_failed"],"title":"SurfaceFreshness","type":"object","uniqueKey":"meta.surfaces.additionalProperties","typeLabel":"SurfaceFreshness · object"},"description":"Freshness by Command Center surface key. Each entry describes its own displayed result, including results without a scan.","title":"Surfaces","type":"object","isRequired":true,"uniqueKey":"meta.surfaces","typeLabel":"Surfaces · object"},"updating":{"default":false,"description":"A newer result is being produced or is not yet displayed.","title":"Updating","type":"boolean","isRequired":true,"uniqueKey":"meta.updating","typeLabel":"boolean"}},"required":["query","data_as_of","partial","updating","last_attempt_failed","surfaces"],"title":"Meta","type":"object","description":"Normalized query and newest included scan.","isRequired":true,"uniqueKey":"meta","typeLabel":"Meta · object"},"next_cursor":{"oneOf":[{"type":"string","title":"Next Cursor","description":"Pass as cursor with the same query to read the next page; null at the end.","isRequired":true,"uniqueKey":"next_cursor.oneOf.0","typeLabel":"string"},{"type":"null","title":"Next Cursor","description":"Pass as cursor with the same query to read the next page; null at the end.","isRequired":true,"uniqueKey":"next_cursor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"next_cursor","typeLabel":"string | null"},"page":{"oneOf":[{"type":"object","title":"CompetitorsPage","required":["period","share_of_voice","leaderboard","capacity","checked_7d","discovered","channels"],"properties":{"capacity":{"description":"Roster size as a pool (MK-4). `cap` is `None` on a workspace with no\nactive subscription to read one off.","properties":{"cap":{"oneOf":[{"type":"integer","title":"Cap","isRequired":true,"uniqueKey":"page.oneOf.0.capacity.cap.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Cap","isRequired":true,"uniqueKey":"page.oneOf.0.capacity.cap.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.capacity.cap","typeLabel":"integer | null"},"used":{"title":"Used","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.capacity.used","typeLabel":"integer"}},"required":["used","cap"],"title":"RosterPool","type":"object","isRequired":true,"uniqueKey":"page.oneOf.0.capacity","typeLabel":"RosterPool · object"},"channels":{"description":"One page of Discovered or of Channels, and how many there are.","properties":{"cells":{"items":{"description":"A brand the answers name that the brand does not track. A channel's\n`score` is null: it is never scored as a competitor.","properties":{"answers":{"title":"Answers","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].answers","typeLabel":"integer"},"brand_key":{"title":"Brand Key","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].brand_key","typeLabel":"string"},"brand_name":{"title":"Brand Name","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].brand_name","typeLabel":"string"},"domain":{"oneOf":[{"type":"string","title":"Domain","isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].domain.oneOf.0","typeLabel":"string"},{"type":"null","title":"Domain","isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].domain.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].domain","typeLabel":"string | null"},"is_new":{"title":"Is New","type":"boolean","isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].is_new","typeLabel":"boolean"},"line":{"title":"Line","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].line","typeLabel":"string"},"mentioned":{"oneOf":[{"type":"integer","title":"Mentioned","isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].mentioned.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Mentioned","isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].mentioned.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].mentioned","typeLabel":"integer | null"},"prompts":{"title":"Prompts","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].prompts","typeLabel":"integer"},"score":{"oneOf":[{"type":"object","title":"ScoreMark","description":"A score or figure from the figures read, with the band it is coloured\nby (#4259).\n\n`key` is the engine or the figure measured. `band` is the Heralded Score's\nband for the value, so a mark and a score read on one scale, and\n\"Not measured\" where no value is served, which includes a group under the\nminimum of answers. On a score, `answers` counts every answer the period\nread under the filters, including those a figure's own denominator leaves\nout.","required":["key","label","value","state","band","answers","tooltip","answer_read_id"],"properties":{"answer_read_id":{"oneOf":[{"type":"string","title":"Answer Read Id","isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].score.oneOf.0.answer_read_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Answer Read Id","isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].score.oneOf.0.answer_read_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].score.oneOf.0.answer_read_id","typeLabel":"string | null"},"answers":{"title":"Answers","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].score.oneOf.0.answers","typeLabel":"integer"},"band":{"title":"Band","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].score.oneOf.0.band","typeLabel":"string"},"key":{"title":"Key","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].score.oneOf.0.key","typeLabel":"string"},"label":{"title":"Label","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].score.oneOf.0.label","typeLabel":"string"},"state":{"title":"State","type":"string","x-extensible-enum":["measured","too_few_answers","calibrating","first_report","not_comparable","not_measured","pending","not_scored"],"isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].score.oneOf.0.state","typeLabel":"string"},"tooltip":{"oneOf":[{"type":"string","title":"Tooltip","isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].score.oneOf.0.tooltip.oneOf.0","typeLabel":"string"},{"type":"null","title":"Tooltip","isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].score.oneOf.0.tooltip.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].score.oneOf.0.tooltip","typeLabel":"string | null"},"value":{"oneOf":[{"type":"integer","title":"Value","isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].score.oneOf.0.value.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Value","isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].score.oneOf.0.value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].score.oneOf.0.value","typeLabel":"integer | null"}},"isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].score.oneOf.0","typeLabel":"ScoreMark · object"},{"type":"null","isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].score.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX].score","typeLabel":"ScoreMark · object | null"}},"required":["brand_key","brand_name","domain","is_new","line","score","mentioned","answers","prompts"],"title":"DiscoveredBrand","type":"object","uniqueKey":"page.oneOf.0.channels.cells.items.[INDEX]","typeLabel":"DiscoveredBrand · object"},"title":"Cells","type":"array","isRequired":true,"uniqueKey":"page.oneOf.0.channels.cells","typeLabel":"DiscoveredBrand · object[]"},"limit":{"title":"Limit","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.channels.limit","typeLabel":"integer"},"offset":{"title":"Offset","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.channels.offset","typeLabel":"integer"},"total":{"title":"Total","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.channels.total","typeLabel":"integer"}},"required":["cells","total","offset","limit"],"title":"DiscoveredPage","type":"object","isRequired":true,"uniqueKey":"page.oneOf.0.channels","typeLabel":"DiscoveredPage · object"},"checked_7d":{"description":"Tracked competitors whose website Herald checked in the last seven days.","title":"Checked 7D","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.checked_7d","typeLabel":"integer"},"discovered":{"description":"One page of Discovered or of Channels, and how many there are.","properties":{"cells":{"items":{"description":"A brand the answers name that the brand does not track. A channel's\n`score` is null: it is never scored as a competitor.","properties":{"answers":{"title":"Answers","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].answers","typeLabel":"integer"},"brand_key":{"title":"Brand Key","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].brand_key","typeLabel":"string"},"brand_name":{"title":"Brand Name","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].brand_name","typeLabel":"string"},"domain":{"oneOf":[{"type":"string","title":"Domain","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].domain.oneOf.0","typeLabel":"string"},{"type":"null","title":"Domain","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].domain.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].domain","typeLabel":"string | null"},"is_new":{"title":"Is New","type":"boolean","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].is_new","typeLabel":"boolean"},"line":{"title":"Line","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].line","typeLabel":"string"},"mentioned":{"oneOf":[{"type":"integer","title":"Mentioned","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].mentioned.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Mentioned","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].mentioned.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].mentioned","typeLabel":"integer | null"},"prompts":{"title":"Prompts","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].prompts","typeLabel":"integer"},"score":{"oneOf":[{"type":"object","title":"ScoreMark","description":"A score or figure from the figures read, with the band it is coloured\nby (#4259).\n\n`key` is the engine or the figure measured. `band` is the Heralded Score's\nband for the value, so a mark and a score read on one scale, and\n\"Not measured\" where no value is served, which includes a group under the\nminimum of answers. On a score, `answers` counts every answer the period\nread under the filters, including those a figure's own denominator leaves\nout.","required":["key","label","value","state","band","answers","tooltip","answer_read_id"],"properties":{"answer_read_id":{"oneOf":[{"type":"string","title":"Answer Read Id","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].score.oneOf.0.answer_read_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Answer Read Id","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].score.oneOf.0.answer_read_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].score.oneOf.0.answer_read_id","typeLabel":"string | null"},"answers":{"title":"Answers","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].score.oneOf.0.answers","typeLabel":"integer"},"band":{"title":"Band","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].score.oneOf.0.band","typeLabel":"string"},"key":{"title":"Key","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].score.oneOf.0.key","typeLabel":"string"},"label":{"title":"Label","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].score.oneOf.0.label","typeLabel":"string"},"state":{"title":"State","type":"string","x-extensible-enum":["measured","too_few_answers","calibrating","first_report","not_comparable","not_measured","pending","not_scored"],"isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].score.oneOf.0.state","typeLabel":"string"},"tooltip":{"oneOf":[{"type":"string","title":"Tooltip","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].score.oneOf.0.tooltip.oneOf.0","typeLabel":"string"},{"type":"null","title":"Tooltip","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].score.oneOf.0.tooltip.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].score.oneOf.0.tooltip","typeLabel":"string | null"},"value":{"oneOf":[{"type":"integer","title":"Value","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].score.oneOf.0.value.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Value","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].score.oneOf.0.value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].score.oneOf.0.value","typeLabel":"integer | null"}},"isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].score.oneOf.0","typeLabel":"ScoreMark · object"},{"type":"null","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].score.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX].score","typeLabel":"ScoreMark · object | null"}},"required":["brand_key","brand_name","domain","is_new","line","score","mentioned","answers","prompts"],"title":"DiscoveredBrand","type":"object","uniqueKey":"page.oneOf.0.discovered.cells.items.[INDEX]","typeLabel":"DiscoveredBrand · object"},"title":"Cells","type":"array","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.cells","typeLabel":"DiscoveredBrand · object[]"},"limit":{"title":"Limit","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.limit","typeLabel":"integer"},"offset":{"title":"Offset","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.offset","typeLabel":"integer"},"total":{"title":"Total","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.discovered.total","typeLabel":"integer"}},"required":["cells","total","offset","limit"],"title":"DiscoveredPage","type":"object","isRequired":true,"uniqueKey":"page.oneOf.0.discovered","typeLabel":"DiscoveredPage · object"},"leaderboard":{"description":"One page of the leaderboard, sorted as asked. `total` is every row.","properties":{"direction":{"enum":["asc","desc"],"title":"Direction","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.direction","typeLabel":"enum\u003cstring>"},"limit":{"title":"Limit","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.limit","typeLabel":"integer"},"offset":{"title":"Offset","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.offset","typeLabel":"integer"},"rows":{"items":{"description":"A tracked brand ranked by the selected side's figure, with ties sharing a place.","properties":{"brand_key":{"title":"Brand Key","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].brand_key","typeLabel":"string"},"brand_name":{"title":"Brand Name","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].brand_name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","title":"Description","description":"The latest stored AI description.","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","description":"The latest stored AI description.","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].description","typeLabel":"string | null"},"domain":{"oneOf":[{"type":"string","title":"Domain","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].domain.oneOf.0","typeLabel":"string"},{"type":"null","title":"Domain","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].domain.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].domain","typeLabel":"string | null"},"is_you":{"title":"Is You","type":"boolean","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].is_you","typeLabel":"boolean"},"mentioned":{"oneOf":[{"type":"integer","title":"Mentioned","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].mentioned.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Mentioned","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].mentioned.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].mentioned","typeLabel":"integer | null"},"mentioned_since":{"oneOf":[{"type":"string","title":"Mentioned Since","description":"Start of a shorter AI measurement population within the selected period.","format":"date-time","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].mentioned_since.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Mentioned Since","description":"Start of a shorter AI measurement population within the selected period.","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].mentioned_since.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].mentioned_since","typeLabel":"string\u003cdate-time> | null"},"product_cards":{"oneOf":[{"type":"object","title":"BrandProductCards","description":"Organic product-card share and positions; null for B2B or Search.","required":["weeks","state","in_product_cards","average_position","best_position"],"properties":{"average_position":{"oneOf":[{"type":"number","title":"Average Position","description":"Mean of each answer's best place for the brand.","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].product_cards.oneOf.0.average_position.oneOf.0","typeLabel":"number"},{"type":"null","title":"Average Position","description":"Mean of each answer's best place for the brand.","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].product_cards.oneOf.0.average_position.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].product_cards.oneOf.0.average_position","typeLabel":"number | null"},"best_position":{"oneOf":[{"type":"integer","title":"Best Position","description":"Lowest organic place for the brand.","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].product_cards.oneOf.0.best_position.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Best Position","description":"Lowest organic place for the brand.","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].product_cards.oneOf.0.best_position.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].product_cards.oneOf.0.best_position","typeLabel":"integer | null"},"in_product_cards":{"description":"Answers showing the brand divided by answers with organic cards.","properties":{"denominator":{"description":"The count it is a share of.","title":"Denominator","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].product_cards.oneOf.0.in_product_cards.denominator","typeLabel":"integer"},"high":{"oneOf":[{"type":"number","title":"High","description":"The 95% range's high end; null with no denominator.","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].product_cards.oneOf.0.in_product_cards.high.oneOf.0","typeLabel":"number"},{"type":"null","title":"High","description":"The 95% range's high end; null with no denominator.","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].product_cards.oneOf.0.in_product_cards.high.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].product_cards.oneOf.0.in_product_cards.high","typeLabel":"number | null"},"low":{"oneOf":[{"type":"number","title":"Low","description":"The 95% range's low end; null with no denominator.","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].product_cards.oneOf.0.in_product_cards.low.oneOf.0","typeLabel":"number"},{"type":"null","title":"Low","description":"The 95% range's low end; null with no denominator.","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].product_cards.oneOf.0.in_product_cards.low.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].product_cards.oneOf.0.in_product_cards.low","typeLabel":"number | null"},"numerator":{"description":"The figure's own count.","title":"Numerator","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].product_cards.oneOf.0.in_product_cards.numerator","typeLabel":"integer"},"value":{"oneOf":[{"type":"number","title":"Value","description":"The share in [0, 1]; null with no denominator.","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].product_cards.oneOf.0.in_product_cards.value.oneOf.0","typeLabel":"number"},{"type":"null","title":"Value","description":"The share in [0, 1]; null with no denominator.","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].product_cards.oneOf.0.in_product_cards.value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].product_cards.oneOf.0.in_product_cards.value","typeLabel":"number | null"}},"required":["value","low","high","numerator","denominator"],"title":"ShoppingShare","type":"object","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].product_cards.oneOf.0.in_product_cards","typeLabel":"ShoppingShare · object"},"state":{"description":"Whether the population's product cards were read.","enum":["read","not_read","not_measured"],"title":"State","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].product_cards.oneOf.0.state","typeLabel":"enum\u003cstring>"},"weeks":{"default":0,"description":"Weekly reports counted from the period measured as ecommerce.","title":"Weeks","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].product_cards.oneOf.0.weeks","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].product_cards.oneOf.0","typeLabel":"BrandProductCards · object"},{"type":"null","description":"Organic product-card share and positions; null for B2B or Search.","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].product_cards.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].product_cards","typeLabel":"BrandProductCards · object | null"},"rank":{"oneOf":[{"type":"integer","title":"Rank","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].rank.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Rank","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].rank.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].rank","typeLabel":"integer | null"},"recommended":{"oneOf":[{"type":"integer","title":"Recommended","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].recommended.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Recommended","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].recommended.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].recommended","typeLabel":"integer | null"},"score":{"description":"A score or figure from the figures read, with the band it is coloured\nby (#4259).\n\n`key` is the engine or the figure measured. `band` is the Heralded Score's\nband for the value, so a mark and a score read on one scale, and\n\"Not measured\" where no value is served, which includes a group under the\nminimum of answers. On a score, `answers` counts every answer the period\nread under the filters, including those a figure's own denominator leaves\nout.","properties":{"answer_read_id":{"oneOf":[{"type":"string","title":"Answer Read Id","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].score.answer_read_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Answer Read Id","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].score.answer_read_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].score.answer_read_id","typeLabel":"string | null"},"answers":{"title":"Answers","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].score.answers","typeLabel":"integer"},"band":{"title":"Band","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].score.band","typeLabel":"string"},"key":{"title":"Key","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].score.key","typeLabel":"string"},"label":{"title":"Label","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].score.label","typeLabel":"string"},"state":{"title":"State","type":"string","x-extensible-enum":["measured","too_few_answers","calibrating","first_report","not_comparable","not_measured","pending","not_scored"],"isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].score.state","typeLabel":"string"},"tooltip":{"oneOf":[{"type":"string","title":"Tooltip","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].score.tooltip.oneOf.0","typeLabel":"string"},{"type":"null","title":"Tooltip","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].score.tooltip.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].score.tooltip","typeLabel":"string | null"},"value":{"oneOf":[{"type":"integer","title":"Value","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].score.value.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Value","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].score.value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].score.value","typeLabel":"integer | null"}},"required":["key","label","value","state","band","answers","tooltip","answer_read_id"],"title":"ScoreMark","type":"object","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].score","typeLabel":"ScoreMark · object"},"trend":{"description":"A score's change, as the Trend column and the pane state it.","properties":{"delta":{"oneOf":[{"type":"integer","title":"Delta","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].trend.delta.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Delta","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].trend.delta.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].trend.delta","typeLabel":"integer | null"},"label":{"oneOf":[{"type":"string","title":"Label","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].trend.label.oneOf.0","typeLabel":"string"},{"type":"null","title":"Label","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].trend.label.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].trend.label","typeLabel":"string | null"},"state":{"enum":["up","down","steady","not_comparable","calibrating","new","none"],"title":"State","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].trend.state","typeLabel":"enum\u003cstring>"}},"required":["state","delta","label"],"title":"PromptTrend","type":"object","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX].trend","typeLabel":"PromptTrend · object"}},"required":["rank","product_cards","brand_key","brand_name","domain","is_you","score","trend","mentioned","recommended","mentioned_since","description"],"title":"CompetitorRow","type":"object","uniqueKey":"page.oneOf.0.leaderboard.rows.items.[INDEX]","typeLabel":"CompetitorRow · object"},"title":"Rows","type":"array","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.rows","typeLabel":"CompetitorRow · object[]"},"sort":{"description":"The selected sort column, echoed from the request.","title":"Sort","type":"string","x-extensible-enum":["brand","score","trend","mentioned","recommended","product_cards"],"isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.sort","typeLabel":"string"},"total":{"title":"Total","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard.total","typeLabel":"integer"}},"required":["rows","total","offset","limit","sort","direction"],"title":"CompetitorBoard","type":"object","isRequired":true,"uniqueKey":"page.oneOf.0.leaderboard","typeLabel":"CompetitorBoard · object"},"period":{"properties":{"excluded_reports":{"title":"Excluded Reports","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.period.excluded_reports","typeLabel":"integer"},"first_answer_at":{"oneOf":[{"type":"string","title":"First Answer At","format":"date-time","isRequired":true,"uniqueKey":"page.oneOf.0.period.first_answer_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"First Answer At","isRequired":true,"uniqueKey":"page.oneOf.0.period.first_answer_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.period.first_answer_at","typeLabel":"string\u003cdate-time> | null"},"last_answer_at":{"oneOf":[{"type":"string","title":"Last Answer At","format":"date-time","isRequired":true,"uniqueKey":"page.oneOf.0.period.last_answer_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Last Answer At","isRequired":true,"uniqueKey":"page.oneOf.0.period.last_answer_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.period.last_answer_at","typeLabel":"string\u003cdate-time> | null"},"preset":{"enum":["1w","4w","12w","all"],"title":"Preset","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.period.preset","typeLabel":"enum\u003cstring>"},"reports":{"title":"Reports","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.period.reports","typeLabel":"integer"}},"required":["preset","reports","first_answer_at","last_answer_at","excluded_reports"],"title":"PeriodDescriptor","type":"object","isRequired":true,"uniqueKey":"page.oneOf.0.period","typeLabel":"PeriodDescriptor · object"},"share_of_voice":{"properties":{"denominator":{"title":"Denominator","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.share_of_voice.denominator","typeLabel":"integer"},"info":{"title":"Info","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.share_of_voice.info","typeLabel":"string"},"population":{"enum":["all_answers","weekly_answers","search_keywords"],"title":"Population","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.share_of_voice.population","typeLabel":"enum\u003cstring>"},"segments":{"items":{"description":"One part of the share-of-voice bar. `pct` is a whole percent, and the\nsegments add up to 100; null where the read measured no share.","properties":{"brand_key":{"oneOf":[{"type":"string","title":"Brand Key","isRequired":true,"uniqueKey":"page.oneOf.0.share_of_voice.segments.items.[INDEX].brand_key.oneOf.0","typeLabel":"string"},{"type":"null","title":"Brand Key","isRequired":true,"uniqueKey":"page.oneOf.0.share_of_voice.segments.items.[INDEX].brand_key.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.share_of_voice.segments.items.[INDEX].brand_key","typeLabel":"string | null"},"count":{"oneOf":[{"type":"integer","title":"Count","isRequired":true,"uniqueKey":"page.oneOf.0.share_of_voice.segments.items.[INDEX].count.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Count","isRequired":true,"uniqueKey":"page.oneOf.0.share_of_voice.segments.items.[INDEX].count.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.share_of_voice.segments.items.[INDEX].count","typeLabel":"integer | null"},"kind":{"enum":["you","competitor","rest","else"],"title":"Kind","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.share_of_voice.segments.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"label":{"title":"Label","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.share_of_voice.segments.items.[INDEX].label","typeLabel":"string"},"numerator":{"title":"Numerator","type":"integer","isRequired":true,"uniqueKey":"page.oneOf.0.share_of_voice.segments.items.[INDEX].numerator","typeLabel":"integer"},"pct":{"oneOf":[{"type":"integer","title":"Pct","isRequired":true,"uniqueKey":"page.oneOf.0.share_of_voice.segments.items.[INDEX].pct.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Pct","isRequired":true,"uniqueKey":"page.oneOf.0.share_of_voice.segments.items.[INDEX].pct.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page.oneOf.0.share_of_voice.segments.items.[INDEX].pct","typeLabel":"integer | null"}},"required":["kind","brand_key","label","pct","numerator","count"],"title":"VoiceSegment","type":"object","uniqueKey":"page.oneOf.0.share_of_voice.segments.items.[INDEX]","typeLabel":"VoiceSegment · object"},"title":"Segments","type":"array","isRequired":true,"uniqueKey":"page.oneOf.0.share_of_voice.segments","typeLabel":"VoiceSegment · object[]"},"state":{"enum":["measured","not_measured","not_comparable"],"title":"State","type":"string","isRequired":true,"uniqueKey":"page.oneOf.0.share_of_voice.state","typeLabel":"enum\u003cstring>"}},"required":["state","population","info","denominator","segments"],"title":"VoiceBox","type":"object","isRequired":true,"uniqueKey":"page.oneOf.0.share_of_voice","typeLabel":"VoiceBox · object"}},"isRequired":true,"uniqueKey":"page.oneOf.0","typeLabel":"CompetitorsPage · object"},{"type":"null","isRequired":true,"uniqueKey":"page.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"page","typeLabel":"CompetitorsPage · object | null"},"period":{"properties":{"excluded_reports":{"title":"Excluded Reports","type":"integer","isRequired":true,"uniqueKey":"period.excluded_reports","typeLabel":"integer"},"first_answer_at":{"oneOf":[{"type":"string","title":"First Answer At","format":"date-time","isRequired":true,"uniqueKey":"period.first_answer_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"First Answer At","isRequired":true,"uniqueKey":"period.first_answer_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"period.first_answer_at","typeLabel":"string\u003cdate-time> | null"},"last_answer_at":{"oneOf":[{"type":"string","title":"Last Answer At","format":"date-time","isRequired":true,"uniqueKey":"period.last_answer_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Last Answer At","isRequired":true,"uniqueKey":"period.last_answer_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"period.last_answer_at","typeLabel":"string\u003cdate-time> | null"},"preset":{"enum":["1w","4w","12w","all"],"title":"Preset","type":"string","isRequired":true,"uniqueKey":"period.preset","typeLabel":"enum\u003cstring>"},"reports":{"title":"Reports","type":"integer","isRequired":true,"uniqueKey":"period.reports","typeLabel":"integer"}},"required":["preset","reports","first_answer_at","last_answer_at","excluded_reports"],"title":"V1Period","type":"object","isRequired":true,"uniqueKey":"period","typeLabel":"V1Period · object"},"share_of_voice":{"properties":{"answers":{"title":"Answers","type":"integer","isRequired":true,"uniqueKey":"share_of_voice.answers","typeLabel":"integer"},"excluded_answers":{"title":"Excluded Answers","type":"integer","isRequired":true,"uniqueKey":"share_of_voice.excluded_answers","typeLabel":"integer"},"population":{"enum":["all_answers","weekly_answers","search_keywords"],"title":"Population","type":"string","isRequired":true,"uniqueKey":"share_of_voice.population","typeLabel":"enum\u003cstring>"},"rows":{"items":{"properties":{"denominator":{"title":"Denominator","type":"integer","isRequired":true,"uniqueKey":"share_of_voice.rows.items.[INDEX].denominator","typeLabel":"integer"},"is_you":{"title":"Is You","type":"boolean","isRequired":true,"uniqueKey":"share_of_voice.rows.items.[INDEX].is_you","typeLabel":"boolean"},"name":{"title":"Name","type":"string","isRequired":true,"uniqueKey":"share_of_voice.rows.items.[INDEX].name","typeLabel":"string"},"numerator":{"title":"Numerator","type":"integer","isRequired":true,"uniqueKey":"share_of_voice.rows.items.[INDEX].numerator","typeLabel":"integer"},"pct":{"oneOf":[{"type":"number","title":"Pct","isRequired":true,"uniqueKey":"share_of_voice.rows.items.[INDEX].pct.oneOf.0","typeLabel":"number"},{"type":"null","title":"Pct","isRequired":true,"uniqueKey":"share_of_voice.rows.items.[INDEX].pct.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"share_of_voice.rows.items.[INDEX].pct","typeLabel":"number | null"}},"required":["name","is_you","numerator","denominator","pct"],"title":"V1VoiceShare","type":"object","uniqueKey":"share_of_voice.rows.items.[INDEX]","typeLabel":"V1VoiceShare · object"},"title":"Rows","type":"array","isRequired":true,"uniqueKey":"share_of_voice.rows","typeLabel":"V1VoiceShare · object[]"},"state":{"enum":["measured","not_measured","not_comparable"],"title":"State","type":"string","isRequired":true,"uniqueKey":"share_of_voice.state","typeLabel":"enum\u003cstring>"}},"required":["population","answers","excluded_answers","state","rows"],"title":"V1ShareOfVoice","type":"object","isRequired":true,"uniqueKey":"share_of_voice","typeLabel":"V1ShareOfVoice · object"},"sides_available":{"description":"The sides the period's reports observed: `ai`, and `search` once a report checked keywords. A read of reports without search observations states `[\"ai\"]`, and `all` is then the AI side.","items":{"enum":["ai","search"],"type":"string","uniqueKey":"sides_available.items.[INDEX]","typeLabel":"enum\u003cstring>"},"title":"Sides Available","type":"array","isRequired":true,"uniqueKey":"sides_available","typeLabel":"enum\u003cstring>[]"},"sites":{"oneOf":[{"type":"object","title":"V1CompetitorSites","description":"Weekly site data and moves with with_details=true.","required":["meta","next_cursor","total","limit","offset","state","reason","rivals","changes"],"example":{"changes":[],"limit":20,"meta":{"data_as_of":null,"last_attempt_failed":false,"partial":false,"query":{},"surfaces":{},"updating":false},"next_cursor":null,"offset":0,"reason":null,"rivals":[],"state":"complete","total":0},"properties":{"changes":{"description":"The week's moves, one per competitor and type of change, each standing for its shallowest page; with `change`, each page of that type. A file, such as a PDF, is never a page.","items":{"properties":{"after":{"oneOf":[{"type":"object","title":"V1CompetitorSiteSnapshot","description":"The changed week's stored values, when available.","required":["week","headline","checks","pricing"],"properties":{"checks":{"oneOf":[{"type":"object","title":"Checks","description":"The stored homepage's offer, audience, reason and next-step checks.","additionalProperties":{"type":"boolean","uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.checks.oneOf.0.additionalProperties","typeLabel":"boolean"},"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.checks.oneOf.0","typeLabel":"Checks · object"},{"type":"null","title":"Checks","description":"The stored homepage's offer, audience, reason and next-step checks.","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.checks.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.checks","typeLabel":"Checks · object | null"},"headline":{"oneOf":[{"type":"string","title":"Headline","description":"The stored homepage headline.","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.headline.oneOf.0","typeLabel":"string"},{"type":"null","title":"Headline","description":"The stored homepage headline.","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.headline.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.headline","typeLabel":"string | null"},"pricing":{"oneOf":[{"type":"object","title":"V1CompetitorPricing","description":"The stored pricing reading for this page.","required":["state","reason","url","plans"],"properties":{"plans":{"oneOf":[{"type":"array","items":{"properties":{"name":{"title":"Name","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.pricing.oneOf.0.plans.oneOf.0.items.[INDEX].name","typeLabel":"string"},"period":{"oneOf":[{"type":"string","title":"Period","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.pricing.oneOf.0.plans.oneOf.0.items.[INDEX].period.oneOf.0","typeLabel":"string"},{"type":"null","title":"Period","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.pricing.oneOf.0.plans.oneOf.0.items.[INDEX].period.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.pricing.oneOf.0.plans.oneOf.0.items.[INDEX].period","typeLabel":"string | null"},"price":{"title":"Price","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.pricing.oneOf.0.plans.oneOf.0.items.[INDEX].price","typeLabel":"string"}},"required":["name","price","period"],"title":"V1CompetitorPlan","type":"object","uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.pricing.oneOf.0.plans.oneOf.0.items.[INDEX]","typeLabel":"V1CompetitorPlan · object"},"title":"Plans","description":"Prices as the page states them; null where pricing could not be read.","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.pricing.oneOf.0.plans.oneOf.0","typeLabel":"V1CompetitorPlan · object[]"},{"type":"null","title":"Plans","description":"Prices as the page states them; null where pricing could not be read.","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.pricing.oneOf.0.plans.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.pricing.oneOf.0.plans","typeLabel":"V1CompetitorPlan · object[] | null"},"reason":{"oneOf":[{"type":"string","title":"Reason","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.pricing.oneOf.0.reason.oneOf.0","typeLabel":"string"},{"type":"null","title":"Reason","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.pricing.oneOf.0.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.pricing.oneOf.0.reason","typeLabel":"string | null"},"state":{"enum":["plans","not_readable","not_found"],"title":"State","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.pricing.oneOf.0.state","typeLabel":"enum\u003cstring>"},"url":{"oneOf":[{"type":"string","title":"Url","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.pricing.oneOf.0.url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Url","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.pricing.oneOf.0.url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.pricing.oneOf.0.url","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.pricing.oneOf.0","typeLabel":"V1CompetitorPricing · object"},{"type":"null","description":"The stored pricing reading for this page.","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.pricing.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.pricing","typeLabel":"V1CompetitorPricing · object | null"},"week":{"description":"The detection week this stored reading describes.","format":"date","title":"Week","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0.week","typeLabel":"string\u003cdate>"}},"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.0","typeLabel":"V1CompetitorSiteSnapshot · object"},{"type":"null","description":"The changed week's stored values, when available.","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].after","typeLabel":"V1CompetitorSiteSnapshot · object | null"},"before":{"oneOf":[{"type":"object","title":"V1CompetitorSiteSnapshot","description":"The previous stored week's values, when available.","required":["week","headline","checks","pricing"],"properties":{"checks":{"oneOf":[{"type":"object","title":"Checks","description":"The stored homepage's offer, audience, reason and next-step checks.","additionalProperties":{"type":"boolean","uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.checks.oneOf.0.additionalProperties","typeLabel":"boolean"},"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.checks.oneOf.0","typeLabel":"Checks · object"},{"type":"null","title":"Checks","description":"The stored homepage's offer, audience, reason and next-step checks.","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.checks.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.checks","typeLabel":"Checks · object | null"},"headline":{"oneOf":[{"type":"string","title":"Headline","description":"The stored homepage headline.","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.headline.oneOf.0","typeLabel":"string"},{"type":"null","title":"Headline","description":"The stored homepage headline.","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.headline.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.headline","typeLabel":"string | null"},"pricing":{"oneOf":[{"type":"object","title":"V1CompetitorPricing","description":"The stored pricing reading for this page.","required":["state","reason","url","plans"],"properties":{"plans":{"oneOf":[{"type":"array","items":{"properties":{"name":{"title":"Name","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.pricing.oneOf.0.plans.oneOf.0.items.[INDEX].name","typeLabel":"string"},"period":{"oneOf":[{"type":"string","title":"Period","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.pricing.oneOf.0.plans.oneOf.0.items.[INDEX].period.oneOf.0","typeLabel":"string"},{"type":"null","title":"Period","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.pricing.oneOf.0.plans.oneOf.0.items.[INDEX].period.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.pricing.oneOf.0.plans.oneOf.0.items.[INDEX].period","typeLabel":"string | null"},"price":{"title":"Price","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.pricing.oneOf.0.plans.oneOf.0.items.[INDEX].price","typeLabel":"string"}},"required":["name","price","period"],"title":"V1CompetitorPlan","type":"object","uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.pricing.oneOf.0.plans.oneOf.0.items.[INDEX]","typeLabel":"V1CompetitorPlan · object"},"title":"Plans","description":"Prices as the page states them; null where pricing could not be read.","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.pricing.oneOf.0.plans.oneOf.0","typeLabel":"V1CompetitorPlan · object[]"},{"type":"null","title":"Plans","description":"Prices as the page states them; null where pricing could not be read.","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.pricing.oneOf.0.plans.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.pricing.oneOf.0.plans","typeLabel":"V1CompetitorPlan · object[] | null"},"reason":{"oneOf":[{"type":"string","title":"Reason","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.pricing.oneOf.0.reason.oneOf.0","typeLabel":"string"},{"type":"null","title":"Reason","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.pricing.oneOf.0.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.pricing.oneOf.0.reason","typeLabel":"string | null"},"state":{"enum":["plans","not_readable","not_found"],"title":"State","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.pricing.oneOf.0.state","typeLabel":"enum\u003cstring>"},"url":{"oneOf":[{"type":"string","title":"Url","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.pricing.oneOf.0.url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Url","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.pricing.oneOf.0.url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.pricing.oneOf.0.url","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.pricing.oneOf.0","typeLabel":"V1CompetitorPricing · object"},{"type":"null","description":"The stored pricing reading for this page.","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.pricing.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.pricing","typeLabel":"V1CompetitorPricing · object | null"},"week":{"description":"The detection week this stored reading describes.","format":"date","title":"Week","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0.week","typeLabel":"string\u003cdate>"}},"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.0","typeLabel":"V1CompetitorSiteSnapshot · object"},{"type":"null","description":"The previous stored week's values, when available.","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].before","typeLabel":"V1CompetitorSiteSnapshot · object | null"},"change":{"enum":["new_page","removed_page","homepage_changed","pricing_changed","key_page_changed"],"title":"Change","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].change","typeLabel":"enum\u003cstring>"},"host":{"title":"Host","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].host","typeLabel":"string"},"insight":{"oneOf":[{"type":"object","title":"ServedInsight","description":"The work that fits the move, a comparison page against the competitor, and the work filed on it; null outside a brand's own read.","required":["id","kinds","work"],"properties":{"id":{"description":"Stable across reads: `finding:\u003cid>`, `check:\u003cpage>:\u003ccheck>`, `page:\u003cclaim>:\u003curl>`, `source:\u003cdomain>`, `rates:\u003cdomain>`, `opinion:\u003cid>`, `topic:\u003ctopic>:\u003csegment>`, `move:\u003ccompetitor>:\u003cchange>:\u003cweek>:\u003curl>`, `question:\u003cprompt>` or `product:\u003cproduct>`.","title":"Id","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].insight.oneOf.0.id","typeLabel":"string"},"kinds":{"description":"The kinds of work that fit it; empty when none does.","items":{"properties":{"credits":{"description":"Content credits starting the work spends; 0 when free.","title":"Credits","type":"integer","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].insight.oneOf.0.kinds.items.[INDEX].credits","typeLabel":"integer"},"play":{"description":"The kind of work, a play key. Send it as `kind` to file it.","title":"Play","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].insight.oneOf.0.kinds.items.[INDEX].play","typeLabel":"string"},"title":{"description":"The work as it would be filed.","title":"Title","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].insight.oneOf.0.kinds.items.[INDEX].title","typeLabel":"string"}},"required":["play","title","credits"],"title":"InsightKind","type":"object","uniqueKey":"sites.oneOf.0.changes.items.[INDEX].insight.oneOf.0.kinds.items.[INDEX]","typeLabel":"InsightKind · object"},"title":"Kinds","type":"array","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].insight.oneOf.0.kinds","typeLabel":"InsightKind · object[]"},"work":{"oneOf":[{"type":"object","title":"InsightWork","description":"The work filed from it, which filing it again returns; null when none is.","required":["id","state","status"],"properties":{"id":{"description":"Open it with get_action or /v1/actions/{id}.","format":"uuid","title":"Id","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].insight.oneOf.0.work.oneOf.0.id","typeLabel":"string\u003cuuid>"},"state":{"description":"The action's state.","title":"State","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].insight.oneOf.0.work.oneOf.0.state","typeLabel":"string"},"status":{"oneOf":[{"type":"string","title":"Status","description":"The customer-facing stage from the work projection; null when not loaded.","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].insight.oneOf.0.work.oneOf.0.status.oneOf.0","typeLabel":"string"},{"type":"null","title":"Status","description":"The customer-facing stage from the work projection; null when not loaded.","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].insight.oneOf.0.work.oneOf.0.status.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].insight.oneOf.0.work.oneOf.0.status","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].insight.oneOf.0.work.oneOf.0","typeLabel":"InsightWork · object"},{"type":"null","description":"The work filed from it, which filing it again returns; null when none is.","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].insight.oneOf.0.work.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].insight.oneOf.0.work","typeLabel":"InsightWork · object | null"}},"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].insight.oneOf.0","typeLabel":"ServedInsight · object"},{"type":"null","description":"The work that fits the move, a comparison page against the competitor, and the work filed on it; null outside a brand's own read.","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].insight.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].insight","typeLabel":"ServedInsight · object | null"},"key":{"title":"Key","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].key","typeLabel":"string"},"name":{"title":"Name","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].name","typeLabel":"string"},"observed_at":{"format":"date-time","title":"Observed At","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].observed_at","typeLabel":"string\u003cdate-time>"},"screenshot_url":{"oneOf":[{"type":"string","title":"Screenshot Url","description":"The current homepage screenshot, never an earlier screenshot.","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].screenshot_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Screenshot Url","description":"The current homepage screenshot, never an earlier screenshot.","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].screenshot_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].screenshot_url","typeLabel":"string | null"},"url":{"title":"Url","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].url","typeLabel":"string"},"week":{"format":"date","title":"Week","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.changes.items.[INDEX].week","typeLabel":"string\u003cdate>"}},"required":["key","name","host","url","change","week","observed_at","before","after","screenshot_url","insight"],"title":"V1CompetitorSiteChange","type":"object","uniqueKey":"sites.oneOf.0.changes.items.[INDEX]","typeLabel":"V1CompetitorSiteChange · object"},"title":"Changes","type":"array","isRequired":true,"uniqueKey":"sites.oneOf.0.changes","typeLabel":"V1CompetitorSiteChange · object[]"},"limit":{"title":"Limit","type":"integer","isRequired":true,"uniqueKey":"sites.oneOf.0.limit","typeLabel":"integer"},"meta":{"properties":{"data_as_of":{"oneOf":[{"type":"object","title":"DataAsOf","required":["id","completed_at"],"properties":{"completed_at":{"format":"date-time","title":"Completed At","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.meta.data_as_of.oneOf.0.completed_at","typeLabel":"string\u003cdate-time>"},"id":{"format":"uuid","title":"Id","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.meta.data_as_of.oneOf.0.id","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"sites.oneOf.0.meta.data_as_of.oneOf.0","typeLabel":"DataAsOf · object"},{"type":"null","isRequired":true,"uniqueKey":"sites.oneOf.0.meta.data_as_of.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.meta.data_as_of","typeLabel":"DataAsOf · object | null"},"last_attempt_failed":{"default":false,"description":"The newest attempt failed; the last good result is displayed.","title":"Last Attempt Failed","type":"boolean","isRequired":true,"uniqueKey":"sites.oneOf.0.meta.last_attempt_failed","typeLabel":"boolean"},"partial":{"default":false,"description":"The displayed response includes a partial report.","title":"Partial","type":"boolean","isRequired":true,"uniqueKey":"sites.oneOf.0.meta.partial","typeLabel":"boolean"},"query":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"sites.oneOf.0.meta.query.additionalProperties","typeLabel":"any"},"title":"Query","type":"object","isRequired":true,"uniqueKey":"sites.oneOf.0.meta.query","typeLabel":"Query · object"},"surfaces":{"additionalProperties":{"properties":{"as_of":{"oneOf":[{"type":"object","title":"SurfaceAsOf","description":"The result displayed here.","required":["scan_id","at"],"properties":{"at":{"description":"When the displayed result was measured.","format":"date-time","title":"At","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.meta.surfaces.additionalProperties.as_of.oneOf.0.at","typeLabel":"string\u003cdate-time>"},"scan_id":{"oneOf":[{"type":"string","title":"Scan Id","description":"The result's scan, null for a timestamp-only result.","format":"uuid","isRequired":true,"uniqueKey":"sites.oneOf.0.meta.surfaces.additionalProperties.as_of.oneOf.0.scan_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Scan Id","description":"The result's scan, null for a timestamp-only result.","isRequired":true,"uniqueKey":"sites.oneOf.0.meta.surfaces.additionalProperties.as_of.oneOf.0.scan_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.meta.surfaces.additionalProperties.as_of.oneOf.0.scan_id","typeLabel":"string\u003cuuid> | null"}},"isRequired":true,"uniqueKey":"sites.oneOf.0.meta.surfaces.additionalProperties.as_of.oneOf.0","typeLabel":"SurfaceAsOf · object"},{"type":"null","description":"The result displayed here.","isRequired":true,"uniqueKey":"sites.oneOf.0.meta.surfaces.additionalProperties.as_of.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.meta.surfaces.additionalProperties.as_of","typeLabel":"SurfaceAsOf · object | null"},"last_attempt_failed":{"default":false,"description":"The newest attempt failed; any displayed result is retained.","title":"Last Attempt Failed","type":"boolean","isRequired":true,"uniqueKey":"sites.oneOf.0.meta.surfaces.additionalProperties.last_attempt_failed","typeLabel":"boolean"},"partial":{"default":false,"description":"The displayed report is partial.","title":"Partial","type":"boolean","isRequired":true,"uniqueKey":"sites.oneOf.0.meta.surfaces.additionalProperties.partial","typeLabel":"boolean"},"updating":{"default":false,"description":"A newer attempt exists whose result is not yet displayed.","title":"Updating","type":"boolean","isRequired":true,"uniqueKey":"sites.oneOf.0.meta.surfaces.additionalProperties.updating","typeLabel":"boolean"}},"required":["as_of","partial","updating","last_attempt_failed"],"title":"SurfaceFreshness","type":"object","uniqueKey":"sites.oneOf.0.meta.surfaces.additionalProperties","typeLabel":"SurfaceFreshness · object"},"description":"Freshness by Command Center surface key. Each entry describes its own displayed result, including results without a scan.","title":"Surfaces","type":"object","isRequired":true,"uniqueKey":"sites.oneOf.0.meta.surfaces","typeLabel":"Surfaces · object"},"updating":{"default":false,"description":"A newer result is being produced or is not yet displayed.","title":"Updating","type":"boolean","isRequired":true,"uniqueKey":"sites.oneOf.0.meta.updating","typeLabel":"boolean"}},"required":["query","data_as_of","partial","updating","last_attempt_failed","surfaces"],"title":"Meta","type":"object","description":"Normalized query and newest included scan.","isRequired":true,"uniqueKey":"sites.oneOf.0.meta","typeLabel":"Meta · object"},"next_cursor":{"oneOf":[{"type":"string","title":"Next Cursor","description":"Pass as cursor with the same query to read the next page; null at the end.","isRequired":true,"uniqueKey":"sites.oneOf.0.next_cursor.oneOf.0","typeLabel":"string"},{"type":"null","title":"Next Cursor","description":"Pass as cursor with the same query to read the next page; null at the end.","isRequired":true,"uniqueKey":"sites.oneOf.0.next_cursor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.next_cursor","typeLabel":"string | null"},"offset":{"title":"Offset","type":"integer","isRequired":true,"uniqueKey":"sites.oneOf.0.offset","typeLabel":"integer"},"reason":{"oneOf":[{"type":"string","title":"Reason","description":"Why the read is incomplete; null when complete.","enum":["no_read","read_running","read_failed"],"isRequired":true,"uniqueKey":"sites.oneOf.0.reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Reason","description":"Why the read is incomplete; null when complete.","isRequired":true,"uniqueKey":"sites.oneOf.0.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.reason","typeLabel":"enum\u003cstring> | null"},"rivals":{"items":{"properties":{"above_the_fold":{"oneOf":[{"type":"object","title":"V1AboveTheFold","description":"What a visitor sees before scrolling, read off the page's screenshot.","required":["url","screenshot_url","load_screenshot_url","captured_at","category","headline","offer","audience","reason","call_to_action","header_action","hero_action_late","regions","proof_on_screen","design","headline_specific","cta_actionable"],"properties":{"audience":{"oneOf":[{"type":"string","title":"Audience","description":"Who it says it is for.","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.audience.oneOf.0","typeLabel":"string"},{"type":"null","title":"Audience","description":"Who it says it is for.","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.audience.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.audience","typeLabel":"string | null"},"call_to_action":{"oneOf":[{"type":"string","title":"Call To Action","description":"The hero's next step.","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.call_to_action.oneOf.0","typeLabel":"string"},{"type":"null","title":"Call To Action","description":"The hero's next step.","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.call_to_action.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.call_to_action","typeLabel":"string | null"},"captured_at":{"format":"date-time","title":"Captured At","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.captured_at","typeLabel":"string\u003cdate-time>"},"category":{"oneOf":[{"type":"string","title":"Category","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.category.oneOf.0","typeLabel":"string"},{"type":"null","title":"Category","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.category.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.category","typeLabel":"string | null"},"cta_actionable":{"enum":["pass","fail","unclear"],"title":"Cta Actionable","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.cta_actionable","typeLabel":"enum\u003cstring>"},"design":{"properties":{"clutter":{"properties":{"verdict":{"enum":["pass","fail","unsure"],"title":"Verdict","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.design.clutter.verdict","typeLabel":"enum\u003cstring>"},"why":{"title":"Why","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.design.clutter.why","typeLabel":"string"}},"required":["verdict","why"],"title":"V1ScreenCheck","type":"object","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.design.clutter","typeLabel":"V1ScreenCheck · object"},"fits_buyer":{"properties":{"verdict":{"enum":["pass","fail","unsure"],"title":"Verdict","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.design.fits_buyer.verdict","typeLabel":"enum\u003cstring>"},"why":{"title":"Why","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.design.fits_buyer.why","typeLabel":"string"}},"required":["verdict","why"],"title":"V1ScreenCheck","type":"object","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.design.fits_buyer","typeLabel":"V1ScreenCheck · object"},"generated_look":{"properties":{"verdict":{"enum":["pass","fail","unsure"],"title":"Verdict","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.design.generated_look.verdict","typeLabel":"enum\u003cstring>"},"why":{"title":"Why","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.design.generated_look.why","typeLabel":"string"}},"required":["verdict","why"],"title":"V1ScreenCheck","type":"object","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.design.generated_look","typeLabel":"V1ScreenCheck · object"},"hierarchy":{"properties":{"verdict":{"enum":["pass","fail","unsure"],"title":"Verdict","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.design.hierarchy.verdict","typeLabel":"enum\u003cstring>"},"why":{"title":"Why","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.design.hierarchy.why","typeLabel":"string"}},"required":["verdict","why"],"title":"V1ScreenCheck","type":"object","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.design.hierarchy","typeLabel":"V1ScreenCheck · object"},"looks_current":{"properties":{"verdict":{"enum":["pass","fail","unsure"],"title":"Verdict","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.design.looks_current.verdict","typeLabel":"enum\u003cstring>"},"why":{"title":"Why","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.design.looks_current.why","typeLabel":"string"}},"required":["verdict","why"],"title":"V1ScreenCheck","type":"object","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.design.looks_current","typeLabel":"V1ScreenCheck · object"},"readability":{"properties":{"verdict":{"enum":["pass","fail","unsure"],"title":"Verdict","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.design.readability.verdict","typeLabel":"enum\u003cstring>"},"why":{"title":"Why","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.design.readability.why","typeLabel":"string"}},"required":["verdict","why"],"title":"V1ScreenCheck","type":"object","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.design.readability","typeLabel":"V1ScreenCheck · object"}},"required":["hierarchy","clutter","readability","looks_current","fits_buyer","generated_look"],"title":"V1Design","type":"object","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.design","typeLabel":"V1Design · object"},"header_action":{"oneOf":[{"type":"string","title":"Header Action","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.header_action.oneOf.0","typeLabel":"string"},{"type":"null","title":"Header Action","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.header_action.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.header_action","typeLabel":"string | null"},"headline":{"oneOf":[{"type":"string","title":"Headline","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.headline.oneOf.0","typeLabel":"string"},{"type":"null","title":"Headline","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.headline.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.headline","typeLabel":"string | null"},"headline_specific":{"enum":["pass","fail","unclear"],"title":"Headline Specific","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.headline_specific","typeLabel":"enum\u003cstring>"},"hero_action_late":{"oneOf":[{"type":"boolean","title":"Hero Action Late","description":"The hero's action appeared only after load; null where not compared.","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.hero_action_late.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Hero Action Late","description":"The hero's action appeared only after load; null where not compared.","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.hero_action_late.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.hero_action_late","typeLabel":"boolean | null"},"load_screenshot_url":{"oneOf":[{"type":"string","title":"Load Screenshot Url","description":"The screenshot at load.","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.load_screenshot_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Load Screenshot Url","description":"The screenshot at load.","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.load_screenshot_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.load_screenshot_url","typeLabel":"string | null"},"offer":{"oneOf":[{"type":"string","title":"Offer","description":"What it says is sold; null where it does not say.","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.offer.oneOf.0","typeLabel":"string"},{"type":"null","title":"Offer","description":"What it says is sold; null where it does not say.","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.offer.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.offer","typeLabel":"string | null"},"proof_on_screen":{"title":"Proof On Screen","type":"boolean","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.proof_on_screen","typeLabel":"boolean"},"reason":{"oneOf":[{"type":"string","title":"Reason","description":"Why choose it.","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.reason.oneOf.0","typeLabel":"string"},{"type":"null","title":"Reason","description":"Why choose it.","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.reason","typeLabel":"string | null"},"regions":{"properties":{"call_to_action":{"oneOf":[{"type":"object","title":"V1Region","required":["x","y","w","h"],"properties":{"h":{"title":"H","type":"number","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.regions.call_to_action.oneOf.0.h","typeLabel":"number"},"w":{"title":"W","type":"number","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.regions.call_to_action.oneOf.0.w","typeLabel":"number"},"x":{"title":"X","type":"number","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.regions.call_to_action.oneOf.0.x","typeLabel":"number"},"y":{"title":"Y","type":"number","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.regions.call_to_action.oneOf.0.y","typeLabel":"number"}},"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.regions.call_to_action.oneOf.0","typeLabel":"V1Region · object"},{"type":"null","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.regions.call_to_action.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.regions.call_to_action","typeLabel":"V1Region · object | null"},"headline":{"oneOf":[{"type":"object","title":"V1Region","required":["x","y","w","h"],"properties":{"h":{"title":"H","type":"number","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.regions.headline.oneOf.0.h","typeLabel":"number"},"w":{"title":"W","type":"number","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.regions.headline.oneOf.0.w","typeLabel":"number"},"x":{"title":"X","type":"number","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.regions.headline.oneOf.0.x","typeLabel":"number"},"y":{"title":"Y","type":"number","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.regions.headline.oneOf.0.y","typeLabel":"number"}},"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.regions.headline.oneOf.0","typeLabel":"V1Region · object"},{"type":"null","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.regions.headline.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.regions.headline","typeLabel":"V1Region · object | null"}},"required":["headline","call_to_action"],"title":"V1Regions","type":"object","description":"Where the headline and action sit, as fractions.","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.regions","typeLabel":"V1Regions · object"},"screenshot_url":{"oneOf":[{"type":"string","title":"Screenshot Url","description":"The screenshot 3 s after load.","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.screenshot_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Screenshot Url","description":"The screenshot 3 s after load.","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.screenshot_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.screenshot_url","typeLabel":"string | null"},"url":{"title":"Url","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0.url","typeLabel":"string"}},"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.0","typeLabel":"V1AboveTheFold · object"},{"type":"null","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].above_the_fold","typeLabel":"V1AboveTheFold · object | null"},"activity":{"items":{"properties":{"key_pages_changed":{"title":"Key Pages Changed","type":"integer","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].activity.items.[INDEX].key_pages_changed","typeLabel":"integer"},"new_pages":{"title":"New Pages","type":"integer","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].activity.items.[INDEX].new_pages","typeLabel":"integer"},"removed_pages":{"title":"Removed Pages","type":"integer","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].activity.items.[INDEX].removed_pages","typeLabel":"integer"},"week":{"format":"date","title":"Week","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].activity.items.[INDEX].week","typeLabel":"string\u003cdate>"}},"required":["week","new_pages","key_pages_changed","removed_pages"],"title":"V1CompetitorActivity","type":"object","uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].activity.items.[INDEX]","typeLabel":"V1CompetitorActivity · object"},"title":"Activity","type":"array","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].activity","typeLabel":"V1CompetitorActivity · object[]"},"categories":{"items":{"properties":{"count":{"title":"Count","type":"integer","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].categories.items.[INDEX].count","typeLabel":"integer"},"group":{"title":"Group","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].categories.items.[INDEX].group","typeLabel":"string"},"name":{"title":"Name","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].categories.items.[INDEX].name","typeLabel":"string"}},"required":["name","group","count"],"title":"V1CompetitorCategory","type":"object","uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].categories.items.[INDEX]","typeLabel":"V1CompetitorCategory · object"},"title":"Categories","type":"array","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].categories","typeLabel":"V1CompetitorCategory · object[]"},"checks":{"oneOf":[{"type":"object","title":"Checks","additionalProperties":{"type":"boolean","uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].checks.oneOf.0.additionalProperties","typeLabel":"boolean"},"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].checks.oneOf.0","typeLabel":"Checks · object"},{"type":"null","title":"Checks","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].checks.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].checks","typeLabel":"Checks · object | null"},"checks_met":{"oneOf":[{"type":"integer","title":"Checks Met","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].checks_met.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Checks Met","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].checks_met.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].checks_met","typeLabel":"integer | null"},"host":{"title":"Host","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].host","typeLabel":"string"},"key":{"title":"Key","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].key","typeLabel":"string"},"key_pages":{"items":{"properties":{"changed":{"title":"Changed","type":"boolean","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].key_pages.items.[INDEX].changed","typeLabel":"boolean"},"checked":{"title":"Checked","type":"boolean","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].key_pages.items.[INDEX].checked","typeLabel":"boolean"},"kind":{"enum":["homepage","pricing","key"],"title":"Kind","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].key_pages.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"url":{"title":"Url","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].key_pages.items.[INDEX].url","typeLabel":"string"}},"required":["url","kind","checked","changed"],"title":"V1CompetitorKeyPage","type":"object","uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].key_pages.items.[INDEX]","typeLabel":"V1CompetitorKeyPage · object"},"title":"Key Pages","type":"array","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].key_pages","typeLabel":"V1CompetitorKeyPage · object[]"},"key_pages_changed":{"oneOf":[{"type":"integer","title":"Key Pages Changed","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].key_pages_changed.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Key Pages Changed","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].key_pages_changed.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].key_pages_changed","typeLabel":"integer | null"},"name":{"title":"Name","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].name","typeLabel":"string"},"new":{"oneOf":[{"type":"integer","title":"New","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].new.oneOf.0","typeLabel":"integer"},{"type":"null","title":"New","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].new.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].new","typeLabel":"integer | null"},"pages":{"oneOf":[{"type":"integer","title":"Pages","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].pages.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Pages","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].pages.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].pages","typeLabel":"integer | null"},"pricing":{"oneOf":[{"type":"object","title":"V1CompetitorPricing","required":["state","reason","url","plans"],"properties":{"plans":{"oneOf":[{"type":"array","items":{"properties":{"name":{"title":"Name","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].pricing.oneOf.0.plans.oneOf.0.items.[INDEX].name","typeLabel":"string"},"period":{"oneOf":[{"type":"string","title":"Period","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].pricing.oneOf.0.plans.oneOf.0.items.[INDEX].period.oneOf.0","typeLabel":"string"},{"type":"null","title":"Period","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].pricing.oneOf.0.plans.oneOf.0.items.[INDEX].period.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].pricing.oneOf.0.plans.oneOf.0.items.[INDEX].period","typeLabel":"string | null"},"price":{"title":"Price","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].pricing.oneOf.0.plans.oneOf.0.items.[INDEX].price","typeLabel":"string"}},"required":["name","price","period"],"title":"V1CompetitorPlan","type":"object","uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].pricing.oneOf.0.plans.oneOf.0.items.[INDEX]","typeLabel":"V1CompetitorPlan · object"},"title":"Plans","description":"Prices as the page states them; null where pricing could not be read.","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].pricing.oneOf.0.plans.oneOf.0","typeLabel":"V1CompetitorPlan · object[]"},{"type":"null","title":"Plans","description":"Prices as the page states them; null where pricing could not be read.","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].pricing.oneOf.0.plans.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].pricing.oneOf.0.plans","typeLabel":"V1CompetitorPlan · object[] | null"},"reason":{"oneOf":[{"type":"string","title":"Reason","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].pricing.oneOf.0.reason.oneOf.0","typeLabel":"string"},{"type":"null","title":"Reason","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].pricing.oneOf.0.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].pricing.oneOf.0.reason","typeLabel":"string | null"},"state":{"enum":["plans","not_readable","not_found"],"title":"State","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].pricing.oneOf.0.state","typeLabel":"enum\u003cstring>"},"url":{"oneOf":[{"type":"string","title":"Url","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].pricing.oneOf.0.url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Url","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].pricing.oneOf.0.url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].pricing.oneOf.0.url","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].pricing.oneOf.0","typeLabel":"V1CompetitorPricing · object"},{"type":"null","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].pricing.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].pricing","typeLabel":"V1CompetitorPricing · object | null"},"proof":{"oneOf":[{"type":"string","title":"Proof","enum":["yes","no","unclear"],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].proof.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Proof","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].proof.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].proof","typeLabel":"enum\u003cstring> | null"},"removed":{"oneOf":[{"type":"integer","title":"Removed","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].removed.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Removed","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].removed.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].removed","typeLabel":"integer | null"},"sameness":{"oneOf":[{"type":"number","title":"Sameness","description":"Copy similarity, from 0 to 1.","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].sameness.oneOf.0","typeLabel":"number"},{"type":"null","title":"Sameness","description":"Copy similarity, from 0 to 1.","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].sameness.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].sameness","typeLabel":"number | null"},"screenshot_url":{"oneOf":[{"type":"string","title":"Screenshot Url","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].screenshot_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Screenshot Url","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].screenshot_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].screenshot_url","typeLabel":"string | null"},"unmeasured":{"additionalProperties":{"type":"string","uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].unmeasured.additionalProperties","typeLabel":"string"},"title":"Unmeasured","type":"object","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].unmeasured","typeLabel":"Unmeasured · object"},"url":{"title":"Url","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].url","typeLabel":"string"},"week":{"oneOf":[{"type":"string","title":"Week","format":"date","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].week.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","title":"Week","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].week.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites.oneOf.0.rivals.items.[INDEX].week","typeLabel":"string\u003cdate> | null"}},"required":["key","name","host","url","screenshot_url","above_the_fold","proof","sameness","pricing","week","pages","new","removed","key_pages_changed","checks","checks_met","key_pages","categories","activity","unmeasured"],"title":"V1CompetitorSite","type":"object","uniqueKey":"sites.oneOf.0.rivals.items.[INDEX]","typeLabel":"V1CompetitorSite · object"},"title":"Rivals","type":"array","isRequired":true,"uniqueKey":"sites.oneOf.0.rivals","typeLabel":"V1CompetitorSite · object[]"},"state":{"enum":["complete","pending","unavailable"],"title":"State","type":"string","isRequired":true,"uniqueKey":"sites.oneOf.0.state","typeLabel":"enum\u003cstring>"},"total":{"title":"Total","type":"integer","isRequired":true,"uniqueKey":"sites.oneOf.0.total","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"sites.oneOf.0","typeLabel":"V1CompetitorSites · object"},{"type":"null","description":"Weekly site data and moves with with_details=true.","isRequired":true,"uniqueKey":"sites.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sites","typeLabel":"V1CompetitorSites · object | null"}},"required":["meta","next_cursor","period","sides_available","competitors","discovered","channels","share_of_voice","page","headline","sites","description_scan_id","description_at"],"title":"V1Competitors","type":"object","uniqueKey":"","typeLabel":"V1Competitors · object"},"examples":{"Example":{"title":"Example","value":{"channels":[],"competitors":[],"description_at":null,"description_scan_id":null,"discovered":[],"headline":null,"meta":{"data_as_of":null,"last_attempt_failed":false,"partial":false,"query":{},"surfaces":{},"updating":false},"next_cursor":null,"page":null,"period":{"excluded_reports":0,"first_answer_at":null,"last_answer_at":null,"preset":"1w","reports":0},"share_of_voice":{"answers":0,"excluded_answers":0,"population":"all_answers","rows":[],"state":"measured"},"sides_available":[],"sites":null}}},"exampleType":"generated"}},"description":"Successful Response","exampleType":"generated"},"45eec2ef-a662-4ff6-ba55-1d35218499d1":{"content":{"application/problem+json":{"example":{"code":"invalid_cursor","detail":"The cursor is invalid or belongs to a different query.","instance":"example-request-id","status":400,"title":"Bad Request","type":"https://docs.heralded.ai/errors-and-limits#invalid_cursor"},"schema":{"description":"An RFC 9457 problem linking its code to human-readable documentation.","properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"instance":{"default":"","title":"Instance","type":"string","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"status":{"title":"Status","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"title":{"title":"Title","type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"type":{"title":"Type","type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"string"}},"required":["type","title","status","detail","code","instance"],"title":"Problem","type":"object","uniqueKey":"","typeLabel":"Problem · object"},"examples":{"Example":{"title":"Example","value":{"code":"invalid_cursor","detail":"The cursor is invalid or belongs to a different query.","instance":"example-request-id","status":400,"title":"Bad Request","type":"https://docs.heralded.ai/errors-and-limits#invalid_cursor"}}},"exampleType":"examples"}},"description":"The cursor is invalid or belongs to a different query.","exampleType":"examples"},"154a5d75-7ab5-4569-a5d5-d77e2937d843":{"content":{"application/problem+json":{"example":{"code":"invalid_token","detail":"The Authorization header carries no API key Heralded knows: it is missing, mistyped, revoked or expired.","instance":"example-request-id","status":401,"title":"Unauthorized","type":"https://docs.heralded.ai/errors-and-limits#invalid_token"},"schema":{"description":"An RFC 9457 problem linking its code to human-readable documentation.","properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"instance":{"default":"","title":"Instance","type":"string","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"status":{"title":"Status","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"title":{"title":"Title","type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"type":{"title":"Type","type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"string"}},"required":["type","title","status","detail","code","instance"],"title":"Problem","type":"object","uniqueKey":"","typeLabel":"Problem · object"},"examples":{"Example":{"title":"Example","value":{"code":"invalid_token","detail":"The Authorization header carries no API key Heralded knows: it is missing, mistyped, revoked or expired.","instance":"example-request-id","status":401,"title":"Unauthorized","type":"https://docs.heralded.ai/errors-and-limits#invalid_token"}}},"exampleType":"examples"}},"description":"No API key, or one that is unknown, revoked or expired.","headers":{"WWW-Authenticate":{"schema":{"example":"Bearer","type":"string"}}},"exampleType":"examples"},"63b72461-8ebe-4297-b0fa-4e7dd960a3e5":{"content":{"application/problem+json":{"example":{"code":"insufficient_scope","detail":"The credential does not have the scope this operation requires.","instance":"example-request-id","status":403,"title":"Forbidden","type":"https://docs.heralded.ai/errors-and-limits#insufficient_scope"},"schema":{"description":"An RFC 9457 problem linking its code to human-readable documentation.","properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"instance":{"default":"","title":"Instance","type":"string","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"status":{"title":"Status","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"title":{"title":"Title","type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"type":{"title":"Type","type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"string"}},"required":["type","title","status","detail","code","instance"],"title":"Problem","type":"object","uniqueKey":"","typeLabel":"Problem · object"},"examples":{"Example":{"title":"Example","value":{"code":"insufficient_scope","detail":"The credential does not have the scope this operation requires.","instance":"example-request-id","status":403,"title":"Forbidden","type":"https://docs.heralded.ai/errors-and-limits#insufficient_scope"}}},"exampleType":"examples"}},"description":"The service token lacks the required scope.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"exampleType":"examples"},"091e673c-8657-45bf-b0fb-52dcd35a092d":{"content":{"application/problem+json":{"example":{"code":"not_found","detail":"Nothing here that this API key can read.","instance":"example-request-id","status":404,"title":"Not Found","type":"https://docs.heralded.ai/errors-and-limits#not_found"},"schema":{"description":"An RFC 9457 problem linking its code to human-readable documentation.","properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"instance":{"default":"","title":"Instance","type":"string","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"status":{"title":"Status","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"title":{"title":"Title","type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"type":{"title":"Type","type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"string"}},"required":["type","title","status","detail","code","instance"],"title":"Problem","type":"object","uniqueKey":"","typeLabel":"Problem · object"},"examples":{"Example":{"title":"Example","value":{"code":"not_found","detail":"Nothing here that this API key can read.","instance":"example-request-id","status":404,"title":"Not Found","type":"https://docs.heralded.ai/errors-and-limits#not_found"}}},"exampleType":"examples"}},"description":"No such brand or answer, or the key's owner cannot read it.","exampleType":"examples"},"b8a7e1c5-6f2b-4cf9-a065-3567ed190b07":{"content":{"application/problem+json":{"example":{"code":"workspace_archived","detail":"The API key's organization is archived.","instance":"example-request-id","status":409,"title":"Conflict","type":"https://docs.heralded.ai/errors-and-limits#workspace_archived"},"schema":{"description":"An RFC 9457 problem linking its code to human-readable documentation.","properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"instance":{"default":"","title":"Instance","type":"string","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"status":{"title":"Status","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"title":{"title":"Title","type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"type":{"title":"Type","type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"string"}},"required":["type","title","status","detail","code","instance"],"title":"Problem","type":"object","uniqueKey":"","typeLabel":"Problem · object"},"examples":{"Example":{"title":"Example","value":{"code":"workspace_archived","detail":"The API key's organization is archived.","instance":"example-request-id","status":409,"title":"Conflict","type":"https://docs.heralded.ai/errors-and-limits#workspace_archived"}}},"exampleType":"examples"}},"description":"The API key's organization is archived.","exampleType":"examples"},"0627edb3-ef51-4784-8a42-c6225cf2e20a":{"content":{"application/problem+json":{"example":{"code":"invalid_request","detail":"The request's parameters are invalid; `errors` names each one.","errors":[{"loc":["query","limit"],"msg":"Input should be less than or equal to 100","type":"less_than_equal"}],"instance":"example-request-id","status":422,"title":"Unprocessable Content","type":"https://docs.heralded.ai/errors-and-limits#invalid_request"},"schema":{"properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"errors":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"errors.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"errors.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"errors.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"title":"Loc","type":"array","isRequired":true,"uniqueKey":"errors.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"title":"Msg","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].msg","typeLabel":"string"},"type":{"title":"Type","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].type","typeLabel":"string"}},"required":["loc","msg","type"],"title":"ValidationIssue","type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"ValidationIssue · object"},"title":"Errors","type":"array","isRequired":true,"uniqueKey":"errors","typeLabel":"ValidationIssue · object[]"},"instance":{"default":"","title":"Instance","type":"string","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"status":{"title":"Status","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"title":{"title":"Title","type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"type":{"title":"Type","type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"string"}},"required":["type","title","status","detail","code","instance","errors"],"title":"ValidationProblem","type":"object","uniqueKey":"","typeLabel":"ValidationProblem · object"},"examples":{"Example":{"title":"Example","value":{"code":"invalid_request","detail":"The request's parameters are invalid; `errors` names each one.","errors":[{"loc":["query","limit"],"msg":"Input should be less than or equal to 100","type":"less_than_equal"}],"instance":"example-request-id","status":422,"title":"Unprocessable Content","type":"https://docs.heralded.ai/errors-and-limits#invalid_request"}}},"exampleType":"examples"}},"description":"A path or query parameter is invalid.","exampleType":"examples"},"c50221ef-61ad-436e-a541-ff694b86fade":{"content":{"application/problem+json":{"example":{"code":"rate_limited","detail":"This caller is past its requests for the minute. Retry after the seconds in Retry-After.","instance":"example-request-id","rate_limit":{"limit":120,"remaining":0,"reset":60,"window":60},"status":429,"title":"Too Many Requests","type":"https://docs.heralded.ai/errors-and-limits#rate_limited"},"schema":{"properties":{"code":{"title":"Code","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"instance":{"default":"","title":"Instance","type":"string","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"rate_limit":{"properties":{"limit":{"title":"Limit","type":"integer","isRequired":true,"uniqueKey":"rate_limit.limit","typeLabel":"integer"},"remaining":{"title":"Remaining","type":"integer","isRequired":true,"uniqueKey":"rate_limit.remaining","typeLabel":"integer"},"reset":{"title":"Reset","type":"integer","isRequired":true,"uniqueKey":"rate_limit.reset","typeLabel":"integer"},"window":{"title":"Window","type":"integer","isRequired":true,"uniqueKey":"rate_limit.window","typeLabel":"integer"}},"required":["limit","window","remaining","reset"],"title":"RateLimitValues","type":"object","isRequired":true,"uniqueKey":"rate_limit","typeLabel":"RateLimitValues · object"},"status":{"title":"Status","type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"title":{"title":"Title","type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"type":{"title":"Type","type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"string"}},"required":["type","title","status","detail","code","instance","rate_limit"],"title":"RateLimitProblem","type":"object","uniqueKey":"","typeLabel":"RateLimitProblem · object"},"examples":{"Example":{"title":"Example","value":{"code":"rate_limited","detail":"This caller is past its requests for the minute. Retry after the seconds in Retry-After.","instance":"example-request-id","rate_limit":{"limit":120,"remaining":0,"reset":60,"window":60},"status":429,"title":"Too Many Requests","type":"https://docs.heralded.ai/errors-and-limits#rate_limited"}}},"exampleType":"examples"}},"description":"The API key made more than 120 requests in the minute.","headers":{"Retry-After":{"description":"Seconds until the key may call again.","schema":{"example":60,"type":"integer"}}},"exampleType":"examples"}},"security":{"4f3ee64e-eba2-4214-93dc-e94778ec97e2":{"serviceToken":{"description":"An organisation service token, sent as Authorization: Bearer hrld_svc_... Scopes: scans:start starts service scans; scans:read reads them; managed:read reads brands, profile, overview, scores, competitors, actions and Snapshots in actively managed organisations; managed:share makes their restricted Snapshots unlisted.","scheme":"bearer","type":"http","scopes":[],"schemeName":"serviceToken"}},"9b43d9e0-cb08-45a9-9e52-c1e4cfa8cc26":{"apiKey":{"description":"An API key, sent as `Authorization: Bearer hrld_...`.","scheme":"bearer","type":"http","scopes":[],"schemeName":"apiKey"}}},"servers":{"2a6c7223-f392-4ed2-a23e-e38a17bdf9a0":{"url":"https://api.heralded.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"An organisation service token, sent as Authorization: Bearer hrld_svc_... Scopes: scans:start starts service scans; scans:read reads them; managed:read reads brands, profile, overview, scores, competitors, actions and Snapshots in actively managed organisations; managed:share makes their restricted Snapshots unlisted.","scheme":"bearer","type":"http","scopes":[],"schemeName":"serviceToken"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An organisation service token, sent as Authorization: Bearer hrld_svc_... Scopes: scans:start starts service scans; scans:read reads them; managed:read reads brands, profile, overview, scores, competitors, actions and Snapshots in actively managed organisations; managed:share makes their restricted Snapshots unlisted.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"serviceToken","name":"Authorization"}],"title":"serviceToken"},{"schemes":[{"scheme":{"description":"An API key, sent as `Authorization: Bearer hrld_...`.","scheme":"bearer","type":"http","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key, sent as `Authorization: Bearer hrld_...`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"growth-path","siteName":"Heralded","title":"Get Competitors - Heralded","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-22T10:17:49.616Z","originalFileLocation":"api-reference/v1/get-competitors.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"The brand and its rivals, ranked by Heralded Score on AI or Mentioned on Search. with_page adds the competitor leaderboard and roster capacity. with_details also includes weekly sites, moves and stored AI descriptions.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Heralded\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/growth-path/SP80dJI2EeXRxpqo/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/growth-path/SP80dJI2EeXRxpqo/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/growth-path/SP80dJI2EeXRxpqo/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/growth-path/SP80dJI2EeXRxpqo/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/growth-path/SP80dJI2EeXRxpqo/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/growth-path/SP80dJI2EeXRxpqo/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/growth-path/SP80dJI2EeXRxpqo/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/growth-path/SP80dJI2EeXRxpqo/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/growth-path/SP80dJI2EeXRxpqo/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Competitors - Heralded\">\u003cmeta data-mint-head property=\"og:description\" content=\"The brand and its rivals, ranked by Heralded Score on AI or Mentioned on Search. with_page adds the competitor leaderboard and roster capacity. with_details also includes weekly sites, moves and stored AI descriptions.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Heralded\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.heralded.ai/api-reference/v1/get-competitors\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://growth-path.mintlify.site/_mintlify/api/og/v2?division=Visibility\u0026amp;title=Get+Competitors\u0026amp;description=The+brand+and+its+rivals%2C+ranked+by+Heralded+Score+on+AI+or+Mentioned+on+Search.%0A%0A%60with_page%60+adds+the+competitor+leaderboard+and+roster+capacity.%0A%60with_details\u0026amp;theme=84eff0b460cc923231a17d34\u0026amp;signature=5682da321b57709bb82812c8e519ea599096bd90779d64641d2d04c440bf75ab\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Competitors - Heralded\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The brand and its rivals, ranked by Heralded Score on AI or Mentioned on Search. with_page adds the competitor leaderboard and roster capacity. with_details also includes weekly sites, moves and stored AI descriptions.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://growth-path.mintlify.site/_mintlify/api/og/v2?division=Visibility\u0026amp;title=Get+Competitors\u0026amp;description=The+brand+and+its+rivals%2C+ranked+by+Heralded+Score+on+AI+or+Mentioned+on+Search.%0A%0A%60with_page%60+adds+the+competitor+leaderboard+and+roster+capacity.%0A%60with_details\u0026amp;theme=84eff0b460cc923231a17d34\u0026amp;signature=5682da321b57709bb82812c8e519ea599096bd90779d64641d2d04c440bf75ab\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/growth-path/SP80dJI2EeXRxpqo/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Heralded\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8a6410\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.heralded.ai/api-reference/v1/get-competitors\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v1/get-competitors.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.heralded.ai/#organization\",\"name\":\"Heralded\",\"url\":\"https://docs.heralded.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/growth-path/c9JZqZZJeoekc9h3/logo/heralded-light.svg?fit=max\u0026auto=format\u0026n=c9JZqZZJeoekc9h3\u0026q=85\u0026s=348eea39d63635c9b888a413b15ada1e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.heralded.ai#website\",\"name\":\"Heralded\",\"url\":\"https://docs.heralded.ai\",\"publisher\":{\"@id\":\"https://docs.heralded.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.heralded.ai/api-reference/v1/get-competitors#webpage\",\"url\":\"https://docs.heralded.ai/api-reference/v1/get-competitors\",\"name\":\"Get Competitors\",\"description\":\"The brand and its rivals, ranked by Heralded Score on AI or Mentioned on Search. with_page adds the competitor leaderboard and roster capacity. with_details also includes weekly sites, moves and stored AI descriptions.\",\"dateModified\":\"2026-11-22T10:17:49.616Z\",\"isPartOf\":{\"@id\":\"https://docs.heralded.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.heralded.ai/api-reference/v1/get-competitors#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.heralded.ai/api-reference/v1/get-competitors#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Visibility\",\"item\":\"https://docs.heralded.ai/api-reference/v1/get-scores\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Competitors\",\"item\":\"https://docs.heralded.ai/api-reference/v1/get-competitors\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.heralded.ai/api-reference/v1/get-competitors#apireference\",\"headline\":\"Get Competitors\",\"name\":\"Get Competitors\",\"description\":\"The brand and its rivals, ranked by Heralded Score on AI or Mentioned on Search. with_page adds the competitor leaderboard and roster capacity. with_details also includes weekly sites, moves and stored AI descriptions.\",\"url\":\"https://docs.heralded.ai/api-reference/v1/get-competitors\",\"mainEntityOfPage\":{\"@id\":\"https://docs.heralded.ai/api-reference/v1/get-competitors#webpage\"},\"dateModified\":\"2026-11-22T10:17:49.616Z\",\"publisher\":{\"@id\":\"https://docs.heralded.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.heralded.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Heralded\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Heralded\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/v1/get-competitors.md","siteName":"Heralded","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"Methodology","pages":[{"title":"Methodology","href":"/methodology/how-we-measure"}]},{"tab":"Developers","pages":[{"title":"Developers","href":"/developers"}]},{"tab":"API reference","groups":[{"group":"Leaderboards","pages":[{"title":"Get Leaderboards","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/leaderboards","href":"/api-reference/v1/get-leaderboards"},{"title":"Get Hall Of Fame","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/leaderboards/hall-of-fame","href":"/api-reference/v1/get-hall-of-fame"},{"title":"Get Sources Hall Of Fame","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/leaderboards/hall-of-fame/sources","href":"/api-reference/v1/get-sources-hall-of-fame"},{"title":"Get Facets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/leaderboards/facets","href":"/api-reference/v1/get-facets"},{"title":"Get Brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/leaderboards/brands/{slug}","href":"/api-reference/v1/get-brand"},{"title":"Get Source","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/sources/{domain}","href":"/api-reference/v1/get-source"}]},{"group":"Brands","pages":[{"title":"Get Brands","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands","href":"/api-reference/v1/get-brands"},{"title":"Get Overview","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/overview","href":"/api-reference/v1/get-overview"},{"title":"Get Brand Snapshots","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/snapshots","href":"/api-reference/v1/get-brand-snapshots"},{"title":"Share Brand Snapshot","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/brands/{brand_id}/snapshots/{share_id}/share","href":"/api-reference/v1/share-brand-snapshot"},{"title":"Get Weekly Brief","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/weekly-brief","href":"/api-reference/v1/get-weekly-brief"},{"title":"Get Week Timeline","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/week-timeline","href":"/api-reference/v1/get-week-timeline"},{"title":"Get Focus Cards","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/focus-cards","href":"/api-reference/v1/get-focus-cards"}]},{"group":"Snapshots","pages":[{"title":"Start Snapshot","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/scans","href":"/api-reference/v1/start-snapshot"},{"title":"Edit Snapshot Profile","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/scans/{scan_id}/profile","href":"/api-reference/v1/edit-snapshot-profile"},{"title":"Run Snapshot","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/scans/{scan_id}/run","href":"/api-reference/v1/run-snapshot"},{"title":"Stop Snapshot","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/scans/{scan_id}/stop","href":"/api-reference/v1/stop-snapshot"},{"title":"Get Scan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/scans/{scan_id}","href":"/api-reference/v1/get-scan"},{"title":"Get Account Scans","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/scans","href":"/api-reference/v1/get-account-scans"}]},{"group":"Visibility","pages":[{"title":"Get Scores","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/scores","href":"/api-reference/v1/get-scores"},{"title":"Get Perception","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/perception","href":"/api-reference/v1/get-perception"},{"title":"Get Perception Claim","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/perception/claims/{claim}","href":"/api-reference/v1/get-perception-claim"},{"title":"Get Moving Away From","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/moving-away-from","href":"/api-reference/v1/get-moving-away-from"},{"title":"Get Reputation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/reputation","href":"/api-reference/v1/get-reputation"},{"title":"Get Reputation Claim","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/reputation/claims/{claim}","href":"/api-reference/v1/get-reputation-claim"},{"title":"Get Reputation Opinion","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/reputation/opinions/{opinion_id}","href":"/api-reference/v1/get-reputation-opinion"},{"title":"Get Prompts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/prompts","href":"/api-reference/v1/get-prompts"},{"title":"Get Prompt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/prompts/{prompt_uid}","href":"/api-reference/v1/get-prompt"},{"title":"Get Answers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/answers","href":"/api-reference/v1/get-answers"},{"title":"Get Answer","description":"One answer in full, with the pages it cited and the rivals it named.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/answers/{answer_id}","href":"/api-reference/v1/get-answer"},{"title":"Get Competitors","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/competitors","href":"/api-reference/v1/get-competitors"},{"title":"Get Competitor","description":"One competitor's period score, trend, comparisons, prompts, engines and cited pages.\n\n`page_url` also opens its rival-page pane, including daily-only discoveries.\nWith it, key can be the page's hostname instead of the competitor's brand key.\n`with_details` adds weekly site changes and stored AI descriptions.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/competitors/{key}","href":"/api-reference/v1/get-competitor"},{"title":"Get Competitor Page","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/competitors/{key}/page","href":"/api-reference/v1/get-competitor-page"},{"title":"Get Sources","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/sources","href":"/api-reference/v1/get-sources"},{"title":"Get Source","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/sources/{domain}","href":"/api-reference/v1/get-source"},{"title":"Get Cited Pages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/cited-pages","href":"/api-reference/v1/get-cited-pages"},{"title":"Get Cited Page","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/cited-page","href":"/api-reference/v1/get-cited-page"},{"title":"Get Changes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/changes","href":"/api-reference/v1/get-changes"}]},{"group":"Site","pages":[{"title":"Get Pages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/pages","href":"/api-reference/v1/get-pages"},{"title":"Get Page","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/pages/{page_id}","href":"/api-reference/v1/get-page"},{"title":"Get Topics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/topics","href":"/api-reference/v1/get-topics"},{"title":"Get Topic","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/topics/{topic_id}","href":"/api-reference/v1/get-topic"},{"title":"Get Keywords","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/keywords","href":"/api-reference/v1/get-keywords"},{"title":"Get Keyword","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/keywords/{keyword_id}","href":"/api-reference/v1/get-keyword"},{"title":"Get Audit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/audit","href":"/api-reference/v1/get-audit"},{"title":"Get Audit Map","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/audit/map","href":"/api-reference/v1/get-audit-map"}]},{"group":"Actions","pages":[{"title":"Get Actions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/actions","href":"/api-reference/v1/get-actions"},{"title":"Get Assets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/assets","href":"/api-reference/v1/get-assets"},{"title":"Get Action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/actions/{action_id}","href":"/api-reference/v1/get-action"},{"title":"Get Action Piece Image","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/actions/{action_id}/piece/images/{slot}","href":"/api-reference/v1/get-action-piece-image"},{"title":"Get Results","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/results","href":"/api-reference/v1/get-results"},{"title":"List Conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/conversations","href":"/api-reference/v1/list-conversations"},{"title":"Get Conversation By Id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/conversations/{conversation_id}/messages","href":"/api-reference/v1/get-conversation-by-id"},{"title":"Get Conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/conversations/{member}","href":"/api-reference/v1/get-conversation"}]},{"group":"Settings and workspaces","pages":[{"title":"Get Free Snapshot","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/account/free-snapshot","href":"/api-reference/v1/get-free-snapshot"},{"title":"Get Brand Settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/settings","href":"/api-reference/v1/get-brand-settings"},{"title":"Get Strategy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/strategy","href":"/api-reference/v1/get-strategy"},{"title":"Get Brand Markets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/markets","href":"/api-reference/v1/get-brand-markets"},{"title":"Get Brand Audiences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/brands/{brand_id}/audiences","href":"/api-reference/v1/get-brand-audiences"},{"title":"Get Organization Usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/organizations/{organization_id}/usage","href":"/api-reference/v1/get-organization-usage"},{"title":"Get Organization Brands","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/organizations/{organization_id}/brands","href":"/api-reference/v1/get-organization-brands"}]}]}]},"basePath":"","title":"Get Competitors - Heralded","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}