{"openapi":"3.1.0","info":{"title":"RookAtlas API","version":"1","description":"Read how a brand appears in AI answers and start measurement runs. Authenticate with an API key from Settings → API keys as `Authorization: Bearer ra_live_…`. Every key can read; `write` adds prompts and `run` spends credits. Each key allows 60 requests a minute."},"servers":[{"url":"https://app.rookatlas.com/api/v1"}],"security":[{"apiKey":[]}],"paths":{"/brands":{"get":{"operationId":"listBrands","summary":"List brands","x-scope":"read","parameters":[],"responses":{"200":{"description":"Brands","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandList"}}}},"400":{"description":"The request is malformed or a parameter is invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, revoked or expired API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key's scopes or its creator's role don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or outside the key's brands","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Conflicts with stored state: a reused Idempotency-Key, or a spent, expired or changed quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; wait for Retry-After seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/brands/{brand_id}":{"get":{"operationId":"getBrand","summary":"Get a brand","x-scope":"read","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The brand","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandDetail"}}}},"400":{"description":"The request is malformed or a parameter is invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, revoked or expired API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key's scopes or its creator's role don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or outside the key's brands","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Conflicts with stored state: a reused Idempotency-Key, or a spent, expired or changed quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; wait for Retry-After seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/brands/{brand_id}/prompts":{"get":{"operationId":"listPrompts","summary":"List prompts","description":"Active and paused prompts, oldest first.","x-scope":"read","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"cursor","in":"query","required":false,"description":"`next_cursor` from the previous page.","schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","required":false,"description":"1–200, default 50.","schema":{"type":"integer","minimum":1,"maximum":200,"default":50}}],"responses":{"200":{"description":"A page of prompts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromptPage"}}}},"400":{"description":"The request is malformed or a parameter is invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, revoked or expired API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key's scopes or its creator's role don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or outside the key's brands","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Conflicts with stored state: a reused Idempotency-Key, or a spent, expired or changed quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; wait for Retry-After seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"addPrompts","summary":"Add prompts","x-scope":"write","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Up to 255 printable ASCII characters. A repeat within 24 hours replays the first response.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddPromptsBody"}}}},"responses":{"200":{"description":"Prompts added","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddPromptsResult"}}}},"400":{"description":"The request is malformed or a parameter is invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, revoked or expired API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key's scopes or its creator's role don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or outside the key's brands","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Conflicts with stored state: a reused Idempotency-Key, or a spent, expired or changed quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; wait for Retry-After seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/brands/{brand_id}/metrics":{"get":{"operationId":"getMetrics","summary":"Get metrics across the engines","x-scope":"read","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"from","in":"query","required":false,"description":"Window start, ISO 8601. Defaults to 30 days before `to`.","schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","required":false,"description":"Window end, ISO 8601. Defaults to now.","schema":{"type":"string","format":"date-time"}},{"name":"engines","in":"query","required":false,"description":"Comma-separated engines (chatgpt, claude, gemini, perplexity, grok, google_ai_mode, google_ai_overview, muse), pooled into one set of numbers. Defaults to all of them.","schema":{"type":"string"}},{"name":"market","in":"query","required":false,"description":"A market id: that market's answers only.","schema":{"type":"string","format":"uuid"}},{"name":"topic","in":"query","required":false,"description":"A topic id, or `none` for prompts under no topic.","schema":{"type":"string"}},{"name":"intent","in":"query","required":false,"description":"Prompts of one intent.","schema":{"type":"string","enum":["informational","commercial","comparison","transactional","navigational"]}},{"name":"branded","in":"query","required":false,"description":"`true` for branded prompts only, `false` for unbranded only.","schema":{"type":"string","enum":["true","false"]}}],"responses":{"200":{"description":"Metrics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Metrics"}}}},"400":{"description":"The request is malformed or a parameter is invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, revoked or expired API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key's scopes or its creator's role don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or outside the key's brands","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Conflicts with stored state: a reused Idempotency-Key, or a spent, expired or changed quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; wait for Retry-After seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/brands/{brand_id}/competitors":{"get":{"operationId":"getCompetitors","summary":"Compare the brand with its competitors","x-scope":"read","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"from","in":"query","required":false,"description":"Window start, ISO 8601. Defaults to 30 days before `to`.","schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","required":false,"description":"Window end, ISO 8601. Defaults to now.","schema":{"type":"string","format":"date-time"}},{"name":"engines","in":"query","required":false,"description":"Comma-separated engines (chatgpt, claude, gemini, perplexity, grok, google_ai_mode, google_ai_overview, muse), pooled into one set of numbers. Defaults to all of them.","schema":{"type":"string"}},{"name":"market","in":"query","required":false,"description":"A market id: that market's answers only.","schema":{"type":"string","format":"uuid"}},{"name":"topic","in":"query","required":false,"description":"A topic id, or `none` for prompts under no topic.","schema":{"type":"string"}},{"name":"intent","in":"query","required":false,"description":"Prompts of one intent.","schema":{"type":"string","enum":["informational","commercial","comparison","transactional","navigational"]}},{"name":"branded","in":"query","required":false,"description":"`true` for branded prompts only, `false` for unbranded only.","schema":{"type":"string","enum":["true","false"]}}],"responses":{"200":{"description":"Competitors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Competitors"}}}},"400":{"description":"The request is malformed or a parameter is invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, revoked or expired API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key's scopes or its creator's role don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or outside the key's brands","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Conflicts with stored state: a reused Idempotency-Key, or a spent, expired or changed quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; wait for Retry-After seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/brands/{brand_id}/sources":{"get":{"operationId":"getSources","summary":"List cited domains","x-scope":"read","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"from","in":"query","required":false,"description":"Window start, ISO 8601. Defaults to 30 days before `to`.","schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","required":false,"description":"Window end, ISO 8601. Defaults to now.","schema":{"type":"string","format":"date-time"}},{"name":"engines","in":"query","required":false,"description":"Comma-separated engines (chatgpt, claude, gemini, perplexity, grok, google_ai_mode, google_ai_overview, muse), pooled into one set of numbers. Defaults to all of them.","schema":{"type":"string"}},{"name":"market","in":"query","required":false,"description":"A market id: that market's answers only.","schema":{"type":"string","format":"uuid"}},{"name":"topic","in":"query","required":false,"description":"A topic id, or `none` for prompts under no topic.","schema":{"type":"string"}},{"name":"intent","in":"query","required":false,"description":"Prompts of one intent.","schema":{"type":"string","enum":["informational","commercial","comparison","transactional","navigational"]}},{"name":"branded","in":"query","required":false,"description":"`true` for branded prompts only, `false` for unbranded only.","schema":{"type":"string","enum":["true","false"]}}],"responses":{"200":{"description":"Sources","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sources"}}}},"400":{"description":"The request is malformed or a parameter is invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, revoked or expired API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key's scopes or its creator's role don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or outside the key's brands","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Conflicts with stored state: a reused Idempotency-Key, or a spent, expired or changed quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; wait for Retry-After seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/brands/{brand_id}/answers":{"get":{"operationId":"listAnswers","summary":"List answers","description":"Every answer in the window, newest first: the wording asked, the answer text, the tracked names in it and the pages it showed. Searches where the engine showed no AI answer are included with `answer_present: false`; failed ones are not. Follow `next_cursor` with the `from` and `to` the first page returned, so the window stays put.","x-scope":"read","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"from","in":"query","required":false,"description":"Window start, ISO 8601. Defaults to 30 days before `to`.","schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","required":false,"description":"Window end, ISO 8601. Defaults to now.","schema":{"type":"string","format":"date-time"}},{"name":"engines","in":"query","required":false,"description":"Comma-separated engines (chatgpt, claude, gemini, perplexity, grok, google_ai_mode, google_ai_overview, muse), pooled into one set of numbers. Defaults to all of them.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"`next_cursor` from the previous page.","schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","required":false,"description":"1–200, default 50.","schema":{"type":"integer","minimum":1,"maximum":200,"default":50}}],"responses":{"200":{"description":"A page of answers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnswerPage"}}}},"400":{"description":"The request is malformed or a parameter is invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, revoked or expired API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key's scopes or its creator's role don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or outside the key's brands","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Conflicts with stored state: a reused Idempotency-Key, or a spent, expired or changed quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; wait for Retry-After seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/brands/{brand_id}/runs":{"get":{"operationId":"listRuns","summary":"List runs","description":"Newest first.","x-scope":"read","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"cursor","in":"query","required":false,"description":"`next_cursor` from the previous page.","schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","required":false,"description":"1–200, default 50.","schema":{"type":"integer","minimum":1,"maximum":200,"default":50}}],"responses":{"200":{"description":"A page of runs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunPage"}}}},"400":{"description":"The request is malformed or a parameter is invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, revoked or expired API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key's scopes or its creator's role don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or outside the key's brands","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Conflicts with stored state: a reused Idempotency-Key, or a spent, expired or changed quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; wait for Retry-After seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"startRun","summary":"Quote or start a run","description":"Runs spend credits, so starting one takes two calls. With `?dry_run=true` the response is a quote that holds for 10 minutes; repeat the same body with `quote_id` to start the run. The run spends at most the quoted credits.","x-scope":"run","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"dry_run","in":"query","required":false,"description":"`true` returns a quote and starts nothing.","schema":{"type":"boolean"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Up to 255 printable ASCII characters. A repeat within 24 hours replays the first response.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunBody"}}}},"responses":{"200":{"description":"A quote (dry run)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Quote"}}}},"202":{"description":"The run started","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunDetail"}}}},"400":{"description":"The request is malformed or a parameter is invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, revoked or expired API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Not enough credits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key's scopes or its creator's role don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or outside the key's brands","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Conflicts with stored state: a reused Idempotency-Key, or a spent, expired or changed quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; wait for Retry-After seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/runs/{run_id}":{"get":{"operationId":"getRun","summary":"Get a run","x-scope":"read","parameters":[{"name":"run_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The run and each engine's outcome","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunDetail"}}}},"400":{"description":"The request is malformed or a parameter is invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, revoked or expired API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key's scopes or its creator's role don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or outside the key's brands","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Conflicts with stored state: a reused Idempotency-Key, or a spent, expired or changed quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; wait for Retry-After seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/audit/robots-txt":{"post":{"operationId":"auditRobotsTxt","summary":"Check a robots.txt for AI crawlers","description":"Judges the text as if it were served at the site's root, against every documented AI crawler. Nothing is fetched and no credits are spent, so a CI job can check the file in a pull request before it ships.","x-scope":"read","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Up to 255 printable ASCII characters. A repeat within 24 hours replays the first response.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RobotsAuditBody"}}}},"responses":{"200":{"description":"Crawler checks and findings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RobotsAudit"}}}},"400":{"description":"The request is malformed or a parameter is invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, revoked or expired API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key's scopes or its creator's role don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or outside the key's brands","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Conflicts with stored state: a reused Idempotency-Key, or a spent, expired or changed quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; wait for Retry-After seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/credits":{"get":{"operationId":"getCredits","summary":"Get the credit balance","x-scope":"read","parameters":[],"responses":{"200":{"description":"Balance","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credits"}}}},"400":{"description":"The request is malformed or a parameter is invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, revoked or expired API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key's scopes or its creator's role don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or outside the key's brands","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Conflicts with stored state: a reused Idempotency-Key, or a spent, expired or changed quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit reached; wait for Retry-After seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"webhooks":{"run.completed":{"post":{"summary":"run.completed","description":"Signed with the endpoint's secret: `webhook-id`, `webhook-timestamp` and `webhook-signature` (v1, HMAC-SHA256 of `{id}.{timestamp}.{body}`). Answer 2xx within 10 seconds; anything else is retried for about a day with the same `webhook-id`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","const":"run.completed"},"timestamp":{"type":"string","description":"ISO 8601, when the event happened."},"data":{"type":"object","properties":{"run_id":{"type":"string"},"brand_id":{"type":"string"},"brand_name":{"type":"string"},"status":{"type":"string","enum":["completed","failed"],"description":"`failed` when no answers were collected; nothing is charged then."},"trigger":{"type":"string","enum":["schedule","manual"]},"engines":{"type":"array","items":{"type":"string","enum":["chatgpt","claude","gemini","perplexity","grok","google_ai_mode","google_ai_overview","muse"]}},"answers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"credits_charged":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"visibility":{"anyOf":[{"type":"object","properties":{"value":{"type":"number"},"low":{"type":"number"},"high":{"type":"number"},"confidence":{"type":"string","enum":["ok","low","insufficient"]}},"required":["value","low","high","confidence"]},{"type":"null"}],"description":"Share of the run's answers naming the brand, with its 95% interval."},"started_at":{"type":"string"},"completed_at":{"type":["string","null"]},"url":{"type":"string"}},"required":["run_id","brand_id","brand_name","status","trigger","engines","answers","credits_charged","visibility","started_at","completed_at","url"]}},"required":["type","timestamp","data"]}}}},"responses":{"200":{"description":"Received"}}}},"recommendation.created":{"post":{"summary":"recommendation.created","description":"Signed with the endpoint's secret: `webhook-id`, `webhook-timestamp` and `webhook-signature` (v1, HMAC-SHA256 of `{id}.{timestamp}.{body}`). Answer 2xx within 10 seconds; anything else is retried for about a day with the same `webhook-id`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","const":"recommendation.created"},"timestamp":{"type":"string","description":"ISO 8601, when the event happened."},"data":{"type":"object","properties":{"recommendation_id":{"type":"string"},"brand_id":{"type":"string"},"brand_name":{"type":"string"},"kind":{"type":"string","enum":["prompt_gap","source_gap","fanout_gap","page_health","stale_page","wrong_claim","site_access"]},"grade":{"type":"string","enum":["official","experiment","correlation","vendor","weak"]},"subject":{"type":"string","description":"What it is about: the prompt, site, search, page, fact or check."},"engines":{"type":"array","items":{"type":"string","enum":["chatgpt","claude","gemini","perplexity","grok","google_ai_mode","google_ai_overview","muse"]}},"first_seen_at":{"type":"string"},"url":{"type":"string"}},"required":["recommendation_id","brand_id","brand_name","kind","grade","subject","engines","first_seen_at","url"]}},"required":["type","timestamp","data"]}}}},"responses":{"200":{"description":"Received"}}}},"article.published":{"post":{"summary":"article.published","description":"Signed with the endpoint's secret: `webhook-id`, `webhook-timestamp` and `webhook-signature` (v1, HMAC-SHA256 of `{id}.{timestamp}.{body}`). Answer 2xx within 10 seconds; anything else is retried for about a day with the same `webhook-id`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","const":"article.published"},"timestamp":{"type":"string","description":"ISO 8601, when the event happened."},"data":{"type":"object","properties":{"draft_id":{"type":"string"},"brand_id":{"type":"string"},"title":{"type":"string"},"post_url":{"type":"string"},"wordpress_post_id":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"published_at":{"type":"string"},"url":{"type":"string"}},"required":["draft_id","brand_id","title","post_url","wordpress_post_id","published_at","url"]}},"required":["type","timestamp","data"]}}}},"responses":{"200":{"description":"Received"}}}}},"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"An API key: ra_live_…"}},"schemas":{"Error":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["invalid_request","unauthorized","insufficient_credits","forbidden","not_found","conflict","rate_limited","provider_unavailable","internal"]},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false},"Market":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"country":{"type":"string"},"language":{"type":"string"}},"required":["id","country","language"],"additionalProperties":false},"Competitor":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"domain":{"type":["string","null"]}},"required":["id","name","domain"],"additionalProperties":false},"Brand":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"domain":{"type":"string"},"category":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"ISO 8601, UTC"}},"required":["id","name","domain","category","created_at"],"additionalProperties":false},"BrandDetail":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"domain":{"type":"string"},"category":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"ISO 8601, UTC"},"description":{"type":["string","null"]},"aliases":{"type":"array","items":{"type":"string"}},"owned_domains":{"type":"array","items":{"type":"string"}},"markets":{"type":"array","items":{"$ref":"#/components/schemas/Market"}},"competitors":{"type":"array","items":{"$ref":"#/components/schemas/Competitor"}}},"required":["id","name","domain","category","created_at","description","aliases","owned_domains","markets","competitors"],"additionalProperties":false},"Prompt":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"text":{"type":"string"},"version":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"type":"string","enum":["active","paused","archived"]},"intent":{"type":"string","enum":["informational","commercial","comparison","transactional","navigational"]},"branded":{"type":"boolean","description":"The prompt names the brand itself."},"market":{"$ref":"#/components/schemas/Market"},"topic":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"ISO 8601, UTC"}},"required":["id","text","version","status","intent","branded","market","topic","created_at"],"additionalProperties":false},"Estimate":{"type":"object","properties":{"value":{"type":"number"},"low":{"type":"number"},"high":{"type":"number"},"answers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"effective_answers":{"type":"number"},"prompts":{"description":"Distinct prompts behind the rate. Absent on reports made before methodology m2.","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"confidence":{"type":"string","enum":["ok","low","insufficient"]}},"required":["value","low","high","answers","effective_answers","confidence"],"additionalProperties":false},"ShareEstimate":{"type":"object","properties":{"value":{"type":"number"},"low":{"type":"number"},"high":{"type":"number"},"mentions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Mentions of every tracked brand: the denominator."},"effective_mentions":{"type":"number"},"prompts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Prompts with at least one tracked mention: the clusters of the interval."},"confidence":{"type":"string","enum":["ok","low","insufficient"]}},"required":["value","low","high","mentions","effective_mentions","prompts","confidence"],"additionalProperties":false},"PositionEstimate":{"type":"object","properties":{"value":{"type":"number"},"low":{"description":"Never below 1. Null when there is no spread to estimate an interval from.","type":["number","null"]},"high":{"type":["number","null"]},"reason":{"anyOf":[{"type":"string","enum":["constant","spread","prompts"]},{"type":"null"}],"description":"Why there is no interval: every answer put the brand at the same place, every prompt has the same mean rank, or there is one prompt. Null when there is one."},"answers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Answers naming the brand."},"effective_answers":{"type":"number"},"prompts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Prompts with an answer naming the brand."},"confidence":{"type":"string","enum":["ok","low","insufficient"]}},"required":["value","low","high","reason","answers","effective_answers","prompts","confidence"],"additionalProperties":false},"Kpis":{"type":"object","properties":{"answers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"prompts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"mention_rate":{"anyOf":[{"$ref":"#/components/schemas/Estimate"},{"type":"null"}]},"owned_citation_rate":{"anyOf":[{"$ref":"#/components/schemas/Estimate"},{"type":"null"}],"description":"Answers that show a link to the brand's own domains."},"share_of_voice":{"anyOf":[{"$ref":"#/components/schemas/ShareEstimate"},{"type":"null"}]},"average_position":{"anyOf":[{"$ref":"#/components/schemas/PositionEstimate"},{"type":"null"}]}},"required":["answers","prompts","mention_rate","owned_citation_rate","share_of_voice","average_position"],"additionalProperties":false},"Comparison":{"type":"object","properties":{"weighting":{"type":"string","const":"equal_per_prompt_version_and_engine"},"pairs":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Prompt version and engine cells asked in both windows."},"prompts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Distinct prompts behind those cells."},"answers":{"type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"previous":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","previous"],"additionalProperties":false,"description":"Answers in the paired cells."},"coverage":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"],"additionalProperties":false,"description":"The share of each window's answers the comparison covers."},"mention_rate":{"anyOf":[{"type":"object","properties":{"current":{"type":"number","description":"The rate in this window, every paired prompt version and engine weighted the same."},"previous":{"type":"number","description":"The same in the window before."},"difference":{"type":"number","description":"current − previous, as a proportion."},"low":{"description":"95% interval of the difference; null when untested.","type":["number","null"]},"high":{"type":["number","null"]},"df":{"description":"Satterthwaite degrees of freedom of the interval.","type":["number","null"]},"verdict":{"type":"string","enum":["up","down","unclear","untested"],"description":"`up` or `down` when the interval excludes zero, `unclear` when it doesn't, `untested` when no test is possible. A tested change counts as real only if the next window agrees."},"reason":{"anyOf":[{"type":"string","enum":["prompts","spread"]},{"type":"null"}],"description":"Why untested: fewer than 10 paired prompts, or no spread between prompts to test against."}},"required":["current","previous","difference","low","high","df","verdict","reason"],"additionalProperties":false},{"type":"null"}]},"owned_citation_rate":{"anyOf":[{"type":"object","properties":{"current":{"type":"number","description":"The rate in this window, every paired prompt version and engine weighted the same."},"previous":{"type":"number","description":"The same in the window before."},"difference":{"type":"number","description":"current − previous, as a proportion."},"low":{"description":"95% interval of the difference; null when untested.","type":["number","null"]},"high":{"type":["number","null"]},"df":{"description":"Satterthwaite degrees of freedom of the interval.","type":["number","null"]},"verdict":{"type":"string","enum":["up","down","unclear","untested"],"description":"`up` or `down` when the interval excludes zero, `unclear` when it doesn't, `untested` when no test is possible. A tested change counts as real only if the next window agrees."},"reason":{"anyOf":[{"type":"string","enum":["prompts","spread"]},{"type":"null"}],"description":"Why untested: fewer than 10 paired prompts, or no spread between prompts to test against."}},"required":["current","previous","difference","low","high","df","verdict","reason"],"additionalProperties":false},{"type":"null"}]},"share_of_voice":{"description":"The mean change in each cell's share of voice. Absent on reports made before it existed.","anyOf":[{"type":"object","properties":{"current":{"type":"number","description":"The rate in this window, every paired prompt version and engine weighted the same."},"previous":{"type":"number","description":"The same in the window before."},"difference":{"type":"number","description":"current − previous, as a proportion."},"low":{"description":"95% interval of the difference; null when untested.","type":["number","null"]},"high":{"type":["number","null"]},"df":{"description":"Satterthwaite degrees of freedom of the interval.","type":["number","null"]},"verdict":{"type":"string","enum":["up","down","unclear","untested"],"description":"`up` or `down` when the interval excludes zero, `unclear` when it doesn't, `untested` when no test is possible. A tested change counts as real only if the next window agrees."},"reason":{"anyOf":[{"type":"string","enum":["prompts","spread"]},{"type":"null"}],"description":"Why untested: fewer than 10 paired prompts, or no spread between prompts to test against."},"cells":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Paired cells this figure's change rests on: for share of voice, cells with tracked mentions in both windows; for average position, cells naming the brand in both."},"prompts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Distinct prompts behind those cells: the clusters of the interval."}},"required":["current","previous","difference","low","high","df","verdict","reason","cells","prompts"],"additionalProperties":false},{"type":"null"}]},"average_position":{"description":"The mean change in each cell's average position where the brand is named in both windows. Lower is better, so `down` is a better place. Read it with `position_naming`. Absent on reports made before it existed.","anyOf":[{"type":"object","properties":{"current":{"type":"number","description":"The rate in this window, every paired prompt version and engine weighted the same."},"previous":{"type":"number","description":"The same in the window before."},"difference":{"type":"number","description":"current − previous, as a proportion."},"low":{"description":"95% interval of the difference; null when untested.","type":["number","null"]},"high":{"type":["number","null"]},"df":{"description":"Satterthwaite degrees of freedom of the interval.","type":["number","null"]},"verdict":{"type":"string","enum":["up","down","unclear","untested"],"description":"`up` or `down` when the interval excludes zero, `unclear` when it doesn't, `untested` when no test is possible. A tested change counts as real only if the next window agrees."},"reason":{"anyOf":[{"type":"string","enum":["prompts","spread"]},{"type":"null"}],"description":"Why untested: fewer than 10 paired prompts, or no spread between prompts to test against."},"cells":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Paired cells this figure's change rests on: for share of voice, cells with tracked mentions in both windows; for average position, cells naming the brand in both."},"prompts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Distinct prompts behind those cells: the clusters of the interval."}},"required":["current","previous","difference","low","high","df","verdict","reason","cells","prompts"],"additionalProperties":false},{"type":"null"}]},"position_naming":{"description":"Cells asked in both windows against the same competitors that name the brand in both (the ones average_position compares), in the window before only, and in this window only. A position change says nothing about cells the brand left or entered.","type":"object","properties":{"both":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lost":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"gained":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["both","lost","gained"],"additionalProperties":false},"same_competitors":{"description":"Prompt version and engine cells asked in both windows against the same tracked competitors: the ones share of voice and position can pair.","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"other_competitors":{"description":"Prompt version and engine cells asked in both windows but left out of share of voice and position because the tracked competitors differed.","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["weighting","pairs","prompts","answers","coverage","mention_rate","owned_citation_rate"],"additionalProperties":false},"Metrics":{"type":"object","properties":{"surfaces":{"type":"array","items":{"type":"string","enum":["chatgpt","claude","gemini","perplexity","grok","google_ai_mode","google_ai_overview","muse"]},"description":"The engines whose answers every number here pools."},"from":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"ISO 8601, UTC"},"to":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"ISO 8601, UTC"},"methodology_version":{"type":"string"},"sentiment":{"description":"Semantic coverage and tone for the configured extractor. Missing analysis is excluded, not neutral. Optional on older report snapshots.","type":"object","properties":{"version":{"type":"string"},"model":{"type":["string","null"]},"eligible":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"analyzed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pending":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"mentions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"distribution":{"type":"object","properties":{"positive":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"neutral":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"mixed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"negative":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["positive","neutral","mixed","negative"],"additionalProperties":false},"net":{"anyOf":[{"type":"object","properties":{"value":{"type":"number"},"low":{"type":["number","null"]},"high":{"type":["number","null"]},"prompts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"confidence":{"type":"string","enum":["ok","low","insufficient"]}},"required":["value","low","high","prompts","confidence"],"additionalProperties":false},{"type":"null"}]},"recommendation_rate":{"anyOf":[{"$ref":"#/components/schemas/Estimate"},{"type":"null"}]}},"required":["version","model","eligible","analyzed","failed","pending","mentions","distribution","net","recommendation_rate"],"additionalProperties":false},"current":{"$ref":"#/components/schemas/Kpis"},"previous":{"description":"The whole window before, as measured. Compare through `comparison`, which pairs like with like.","$ref":"#/components/schemas/Kpis"},"comparison":{"description":"The tested change since the window before. Absent on reports made before it existed.","$ref":"#/components/schemas/Comparison"},"engines":{"type":"array","items":{"type":"object","properties":{"answers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"prompts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"mention_rate":{"anyOf":[{"$ref":"#/components/schemas/Estimate"},{"type":"null"}]},"owned_citation_rate":{"anyOf":[{"$ref":"#/components/schemas/Estimate"},{"type":"null"}],"description":"Answers that show a link to the brand's own domains."},"share_of_voice":{"anyOf":[{"$ref":"#/components/schemas/ShareEstimate"},{"type":"null"}]},"average_position":{"anyOf":[{"$ref":"#/components/schemas/PositionEstimate"},{"type":"null"}]},"surface":{"type":"string","enum":["chatgpt","claude","gemini","perplexity","grok","google_ai_mode","google_ai_overview","muse"]}},"required":["answers","prompts","mention_rate","owned_citation_rate","share_of_voice","average_position","surface"],"additionalProperties":false}},"trend":{"type":"array","items":{"type":"object","properties":{"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"ISO 8601, UTC"},"answers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"mention_rate":{"anyOf":[{"$ref":"#/components/schemas/Estimate"},{"type":"null"}]}},"required":["at","answers","mention_rate"],"additionalProperties":false}}},"required":["surfaces","from","to","methodology_version","current","previous","engines","trend"],"additionalProperties":false},"Competitors":{"type":"object","properties":{"surfaces":{"type":"array","items":{"type":"string","enum":["chatgpt","claude","gemini","perplexity","grok","google_ai_mode","google_ai_overview","muse"]},"description":"The engines whose answers every number here pools."},"from":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"ISO 8601, UTC"},"to":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"ISO 8601, UTC"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"domain":{"type":["string","null"]},"is_brand":{"type":"boolean"},"mention_rate":{"anyOf":[{"$ref":"#/components/schemas/Estimate"},{"type":"null"}]},"share_of_voice":{"anyOf":[{"$ref":"#/components/schemas/ShareEstimate"},{"type":"null"}],"description":"Its mentions over the mentions of every tracked brand, on the same answers. Archived competitors' mentions stay in the denominator, so the rows need not sum to 1."},"average_position":{"anyOf":[{"$ref":"#/components/schemas/PositionEstimate"},{"type":"null"}]},"top_ones":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Answers where it is named first."},"prompts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["id","name","domain","is_brand","mention_rate","share_of_voice","average_position","top_ones","prompts"],"additionalProperties":false}}},"required":["surfaces","from","to","data"],"additionalProperties":false},"Sources":{"type":"object","properties":{"surfaces":{"type":"array","items":{"type":"string","enum":["chatgpt","claude","gemini","perplexity","grok","google_ai_mode","google_ai_overview","muse"]},"description":"The engines whose answers every number here pools."},"from":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"ISO 8601, UTC"},"to":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"ISO 8601, UTC"},"answers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"owned_answers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"domains":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string"},"answers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"share":{"type":"number"},"surfaces":{"type":"array","items":{"type":"string","enum":["chatgpt","claude","gemini","perplexity","grok","google_ai_mode","google_ai_overview","muse"]}},"kind":{"type":"string","enum":["owned","competitor","third_party"]},"competitor_name":{"type":["string","null"]},"page_type":{"description":"What kind of site it is, from its address: review sites, news, Reddit and so on. Always present in API responses.","type":"string","enum":["owned","competitor","review","marketplace","news","wikipedia","reddit","youtube","forum","social","reference","other"]},"top_urls":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"title":{"description":"From the page's own metadata, once it has been read.","type":["string","null"]},"author":{"description":"The page's byline, once it has been read.","type":["string","null"]}},"required":["url","count"],"additionalProperties":false}}},"required":["domain","answers","share","surfaces","kind","competitor_name","top_urls"],"additionalProperties":false}},"page_types":{"description":"Answers citing at least one page of each type, most first. Always present in API responses.","type":"array","items":{"type":"object","properties":{"page_type":{"type":"string","enum":["owned","competitor","review","marketplace","news","wikipedia","reddit","youtube","forum","social","reference","other"]},"answers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"share":{"type":"number"}},"required":["page_type","answers","share"],"additionalProperties":false}},"retrieved":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string"},"answers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"share":{"type":"number"}},"required":["domain","answers","share"],"additionalProperties":false}}},"required":["surfaces","from","to","answers","owned_answers","domains","retrieved"],"additionalProperties":false},"Run":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"brand_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["pending","running","completed","failed","skipped_no_credits","canceled"]},"trigger":{"type":"string","enum":["schedule","manual"]},"engine_mode":{"type":"string","enum":["live","demo"],"description":"`demo` answers are generated locally and never come from an engine."},"surfaces":{"type":"array","items":{"type":"string","enum":["chatgpt","claude","gemini","perplexity","grok","google_ai_mode","google_ai_overview","muse"]}},"replicates":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"bundles":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Prompts × replicates; one credit each."},"executions":{"type":"object","properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"done":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["total","done","failed"],"additionalProperties":false},"created_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"ISO 8601, UTC"},"started_at":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"ISO 8601, UTC"},{"type":"null"}]},"completed_at":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"ISO 8601, UTC"},{"type":"null"}]}},"required":["id","brand_id","status","trigger","engine_mode","surfaces","replicates","bundles","executions","created_at","started_at","completed_at"],"additionalProperties":false},"RunDetail":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"brand_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["pending","running","completed","failed","skipped_no_credits","canceled"]},"trigger":{"type":"string","enum":["schedule","manual"]},"engine_mode":{"type":"string","enum":["live","demo"],"description":"`demo` answers are generated locally and never come from an engine."},"surfaces":{"type":"array","items":{"type":"string","enum":["chatgpt","claude","gemini","perplexity","grok","google_ai_mode","google_ai_overview","muse"]}},"replicates":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"bundles":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Prompts × replicates; one credit each."},"executions":{"type":"object","properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"done":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["total","done","failed"],"additionalProperties":false},"created_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"ISO 8601, UTC"},"started_at":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"ISO 8601, UTC"},{"type":"null"}]},"completed_at":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"ISO 8601, UTC"},{"type":"null"}]},"engines":{"type":"array","items":{"type":"object","properties":{"surface":{"type":"string","enum":["chatgpt","claude","gemini","perplexity","grok","google_ai_mode","google_ai_overview","muse"]},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"processed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"answered":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"no_answer":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["surface","total","processed","answered","no_answer","failed"],"additionalProperties":false}}},"required":["id","brand_id","status","trigger","engine_mode","surfaces","replicates","bundles","executions","created_at","started_at","completed_at","engines"],"additionalProperties":false},"Answer":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"run_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"prompt_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"prompt":{"type":"string","description":"The prompt's wording as it was asked in this run."},"market":{"type":"object","properties":{"country":{"type":"string"},"language":{"type":"string"}},"required":["country","language"],"additionalProperties":false},"surface":{"type":"string","enum":["chatgpt","claude","gemini","perplexity","grok","google_ai_mode","google_ai_overview","muse"]},"engine_mode":{"type":"string","enum":["live","demo"],"description":"`demo` answers are generated locally and never come from an engine."},"collected_at":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"ISO 8601, UTC"},{"type":"null"}]},"answer_present":{"type":"boolean"},"text":{"description":"The answer as Markdown.","type":["string","null"]},"names":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"kind":{"type":"string","enum":["brand","competitor","other"]},"position":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"1 for the first name the answer gives."}},"required":["name","kind","position"],"additionalProperties":false},"description":"Tracked names in the order they first appear."},"citations":{"type":"array","items":{"type":"object","properties":{"position":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"url":{"type":"string"},"domain":{"type":["string","null"]},"title":{"type":["string","null"]},"placement":{"type":"string","enum":["inline","source_panel","retrieved"],"description":"`retrieved`: the engine read the page but didn't show it; it counts toward no metric."},"kind":{"type":"string","enum":["owned","competitor","third_party"]}},"required":["position","url","domain","title","placement","kind"],"additionalProperties":false},"description":"Pages in the order the answer gave them."},"searches":{"type":"array","items":{"type":"string"},"description":"Searches the engine reported running for this answer, where it reports them."}},"required":["id","run_id","prompt_id","prompt","market","surface","engine_mode","collected_at","answer_present","text","names","citations","searches"],"additionalProperties":false},"Quote":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","const":"run"},"brand_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"surfaces":{"type":"array","items":{"type":"string","enum":["chatgpt","claude","gemini","perplexity","grok","google_ai_mode","google_ai_overview","muse"]}},"replicates":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"prompts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"answers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"credits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The most the run will spend."},"available_credits":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The workspace balance now; null for keys and connections locked to some brands."},"expires_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"ISO 8601, UTC"}},"required":["id","kind","brand_id","surfaces","replicates","prompts","answers","credits","available_credits","expires_at"],"additionalProperties":false},"Credits":{"type":"object","properties":{"available":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"held":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Reserved by runs in progress."},"debt":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lots":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"source":{"type":"string","enum":["plan_grant","plan_upgrade","topup","free_signup","free_monthly","reissue","adjustment","referral"]},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"available":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"held":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"expires_at":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"ISO 8601, UTC"},{"type":"null"}]},"eligible_surfaces":{"anyOf":[{"type":"array","items":{"type":"string","enum":["chatgpt","claude","gemini","perplexity","grok","google_ai_mode","google_ai_overview","muse"]}},{"type":"null"}]}},"required":["id","source","amount","available","held","expires_at","eligible_surfaces"],"additionalProperties":false}}},"required":["available","held","debt","lots"],"additionalProperties":false},"BrandList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Brand"}}},"required":["data"],"additionalProperties":false},"PromptPage":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Prompt"}},"next_cursor":{"type":["string","null"]}},"required":["data","next_cursor"],"additionalProperties":false},"RunPage":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Run"}},"next_cursor":{"type":["string","null"]}},"required":["data","next_cursor"],"additionalProperties":false},"AnswerPage":{"type":"object","properties":{"surfaces":{"type":"array","items":{"type":"string","enum":["chatgpt","claude","gemini","perplexity","grok","google_ai_mode","google_ai_overview","muse"]},"description":"The engines whose answers every number here pools."},"from":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"ISO 8601, UTC"},"to":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"ISO 8601, UTC"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Answer"}},"next_cursor":{"type":["string","null"]}},"required":["surfaces","from","to","data","next_cursor"],"additionalProperties":false},"AddPromptsBody":{"type":"object","properties":{"market_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"topic":{"type":"string","maxLength":60},"texts":{"minItems":1,"maxItems":200,"type":"array","items":{"type":"string","minLength":5,"maxLength":500}}},"required":["market_id","texts"]},"RobotsAuditBody":{"type":"object","properties":{"robots_txt":{"type":"string","maxLength":512000,"description":"The file's text; Google reads at most 500 KiB."},"path":{"description":"The path to check crawlers against. Defaults to `/`.","type":"string","maxLength":2000,"format":"starts_with","pattern":"^\\/.*"}},"required":["robots_txt"]},"RobotsAudit":{"type":"object","properties":{"crawlers":{"type":"array","items":{"type":"object","properties":{"token":{"type":"string"},"owner":{"type":"string"},"purpose":{"type":"string","enum":["search","grounding","user","training"]},"status":{"type":"string","enum":["pass","fail","warn","info","unknown"]},"rule":{"description":"The rule that decided it, e.g. `Disallow: /`.","type":["string","null"]},"detail":{"type":"string"}},"required":["token","owner","purpose","status","rule","detail"],"additionalProperties":false}},"findings":{"type":"array","items":{"type":"object","properties":{"grade":{"type":"string","enum":["official","experiment","correlation","vendor","weak"]},"title":{"type":"string"},"detail":{"type":"string"},"fix":{"description":"Lines to add to robots.txt.","type":["string","null"]},"doc":{"type":"string"}},"required":["grade","title","detail","fix","doc"],"additionalProperties":false}}},"required":["crawlers","findings"],"additionalProperties":false},"AddPromptsResult":{"type":"object","properties":{"added":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["added"],"additionalProperties":false},"RunBody":{"type":"object","properties":{"surfaces":{"minItems":1,"type":"array","items":{"type":"string","enum":["chatgpt","claude","gemini","perplexity","grok","google_ai_mode","google_ai_overview","muse"]}},"replicates":{"default":1,"type":"integer","minimum":1,"maximum":5},"quote_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["surfaces"]}}}}