{"openapi":"3.1.0","info":{"title":"Onym API","description":"Read your AI visibility data: metrics, time series, competitors, prompts, sources, answers, changes and opportunities. Authenticate with `Authorization: Bearer nod_...` (create keys in your dashboard's Settings). Filters match the dashboard. Rates include `k`, `n`, `low` and `high` (95% Wilson range); changes are `significant` only when ranges separate.","version":"1.0"},"paths":{"/domains":{"get":{"summary":"Domains in this workspace","operationId":"list_domains_domains_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Bearer nod_...","title":"Authorization"},"description":"Bearer nod_..."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/domains/{domain}/metrics":{"get":{"summary":"Headline metrics with sample sizes and changes","operationId":"get_metrics_domains__domain__metrics_get","parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}},{"name":"range","in":"query","required":false,"schema":{"type":"string","description":"7d | 30d | 90d | all","default":"30d","title":"Range"},"description":"7d | 30d | 90d | all"},{"name":"surface","in":"query","required":false,"schema":{"type":"string","description":"Surface key, e.g. chatgpt_app:chat","default":"","title":"Surface"},"description":"Surface key, e.g. chatgpt_app:chat"},{"name":"topic","in":"query","required":false,"schema":{"type":"string","default":"","title":"Topic"}},{"name":"branded","in":"query","required":false,"schema":{"type":"string","description":"unbranded | all | branded","default":"unbranded","title":"Branded"},"description":"unbranded | all | branded"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Bearer nod_...","title":"Authorization"},"description":"Bearer nod_..."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/domains/{domain}/timeseries":{"get":{"summary":"Visibility per run for you and top competitors","operationId":"get_timeseries_domains__domain__timeseries_get","parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}},{"name":"range","in":"query","required":false,"schema":{"type":"string","description":"7d | 30d | 90d | all","default":"30d","title":"Range"},"description":"7d | 30d | 90d | all"},{"name":"surface","in":"query","required":false,"schema":{"type":"string","description":"Surface key, e.g. chatgpt_app:chat","default":"","title":"Surface"},"description":"Surface key, e.g. chatgpt_app:chat"},{"name":"topic","in":"query","required":false,"schema":{"type":"string","default":"","title":"Topic"}},{"name":"branded","in":"query","required":false,"schema":{"type":"string","description":"unbranded | all | branded","default":"unbranded","title":"Branded"},"description":"unbranded | all | branded"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Bearer nod_...","title":"Authorization"},"description":"Bearer nod_..."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/domains/{domain}/competitors":{"get":{"summary":"Benchmark of tracked brands, plus untracked brands named","operationId":"get_competitors_domains__domain__competitors_get","parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}},{"name":"range","in":"query","required":false,"schema":{"type":"string","description":"7d | 30d | 90d | all","default":"30d","title":"Range"},"description":"7d | 30d | 90d | all"},{"name":"surface","in":"query","required":false,"schema":{"type":"string","description":"Surface key, e.g. chatgpt_app:chat","default":"","title":"Surface"},"description":"Surface key, e.g. chatgpt_app:chat"},{"name":"topic","in":"query","required":false,"schema":{"type":"string","default":"","title":"Topic"}},{"name":"branded","in":"query","required":false,"schema":{"type":"string","description":"unbranded | all | branded","default":"unbranded","title":"Branded"},"description":"unbranded | all | branded"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Bearer nod_...","title":"Authorization"},"description":"Bearer nod_..."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/domains/{domain}/prompts":{"get":{"summary":"Prompt set with per-prompt performance","operationId":"get_prompts_domains__domain__prompts_get","parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}},{"name":"range","in":"query","required":false,"schema":{"type":"string","description":"7d | 30d | 90d | all","default":"30d","title":"Range"},"description":"7d | 30d | 90d | all"},{"name":"surface","in":"query","required":false,"schema":{"type":"string","description":"Surface key, e.g. chatgpt_app:chat","default":"","title":"Surface"},"description":"Surface key, e.g. chatgpt_app:chat"},{"name":"topic","in":"query","required":false,"schema":{"type":"string","default":"","title":"Topic"}},{"name":"branded","in":"query","required":false,"schema":{"type":"string","description":"unbranded | all | branded","default":"unbranded","title":"Branded"},"description":"unbranded | all | branded"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Bearer nod_...","title":"Authorization"},"description":"Bearer nod_..."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Add questions (arrive as suggestions; needs a write key)","operationId":"post_prompts_domains__domain__prompts_post","parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Bearer nod_...","title":"Authorization"},"description":"Bearer nod_..."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewPrompts"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/domains/{domain}/prompts/{prompt_id}":{"get":{"summary":"One prompt: metrics, brands, sources, latest answers","operationId":"get_prompt_domains__domain__prompts__prompt_id__get","parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}},{"name":"prompt_id","in":"path","required":true,"schema":{"type":"string","title":"Prompt Id"}},{"name":"range","in":"query","required":false,"schema":{"type":"string","description":"7d | 30d | 90d | all","default":"30d","title":"Range"},"description":"7d | 30d | 90d | all"},{"name":"surface","in":"query","required":false,"schema":{"type":"string","description":"Surface key, e.g. chatgpt_app:chat","default":"","title":"Surface"},"description":"Surface key, e.g. chatgpt_app:chat"},{"name":"topic","in":"query","required":false,"schema":{"type":"string","default":"","title":"Topic"}},{"name":"branded","in":"query","required":false,"schema":{"type":"string","description":"unbranded | all | branded","default":"unbranded","title":"Branded"},"description":"unbranded | all | branded"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Bearer nod_...","title":"Authorization"},"description":"Bearer nod_..."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/domains/{domain}/sources":{"get":{"summary":"Cited domains and URLs (view=gap for outreach targets)","operationId":"get_sources_domains__domain__sources_get","parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}},{"name":"view","in":"query","required":false,"schema":{"type":"string","default":"all","title":"View"}},{"name":"range","in":"query","required":false,"schema":{"type":"string","description":"7d | 30d | 90d | all","default":"30d","title":"Range"},"description":"7d | 30d | 90d | all"},{"name":"surface","in":"query","required":false,"schema":{"type":"string","description":"Surface key, e.g. chatgpt_app:chat","default":"","title":"Surface"},"description":"Surface key, e.g. chatgpt_app:chat"},{"name":"topic","in":"query","required":false,"schema":{"type":"string","default":"","title":"Topic"}},{"name":"branded","in":"query","required":false,"schema":{"type":"string","description":"unbranded | all | branded","default":"unbranded","title":"Branded"},"description":"unbranded | all | branded"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Bearer nod_...","title":"Authorization"},"description":"Bearer nod_..."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/domains/{domain}/answers":{"get":{"summary":"Answers behind the numbers, newest first","operationId":"get_answers_domains__domain__answers_get","parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}},{"name":"show","in":"query","required":false,"schema":{"type":"string","description":"'' | missing | mentioned","default":"","title":"Show"},"description":"'' | missing | mentioned"},{"name":"search","in":"query","required":false,"schema":{"type":"string","default":"","title":"Search"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Offset"}},{"name":"include_text","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Text"}},{"name":"range","in":"query","required":false,"schema":{"type":"string","description":"7d | 30d | 90d | all","default":"30d","title":"Range"},"description":"7d | 30d | 90d | all"},{"name":"surface","in":"query","required":false,"schema":{"type":"string","description":"Surface key, e.g. chatgpt_app:chat","default":"","title":"Surface"},"description":"Surface key, e.g. chatgpt_app:chat"},{"name":"topic","in":"query","required":false,"schema":{"type":"string","default":"","title":"Topic"}},{"name":"branded","in":"query","required":false,"schema":{"type":"string","description":"unbranded | all | branded","default":"unbranded","title":"Branded"},"description":"unbranded | all | branded"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Bearer nod_...","title":"Authorization"},"description":"Bearer nod_..."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/domains/{domain}/answers/{answer_id}":{"get":{"summary":"One answer with full text, brands and citations","operationId":"get_answer_domains__domain__answers__answer_id__get","parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}},{"name":"answer_id","in":"path","required":true,"schema":{"type":"string","title":"Answer Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Bearer nod_...","title":"Authorization"},"description":"Bearer nod_..."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/domains/{domain}/changes":{"get":{"summary":"Significant changes, run over run","operationId":"get_changes_domains__domain__changes_get","parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":8,"title":"Limit"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Bearer nod_...","title":"Authorization"},"description":"Bearer nod_..."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/domains/{domain}/opportunities":{"get":{"summary":"Opportunities with evidence and measured impact","operationId":"get_opportunities_domains__domain__opportunities_get","parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","description":"open | in_progress | shipped | all","default":"open","title":"Status"},"description":"open | in_progress | shipped | all"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Bearer nod_...","title":"Authorization"},"description":"Bearer nod_..."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/datasets":{"get":{"summary":"Flat datasets available for BI tools","operationId":"list_datasets_datasets_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/domains/{domain}/datasets/{name}.csv":{"get":{"summary":"The same dataset as CSV (for Google Sheets IMPORTDATA)","description":"Spreadsheets can't send headers, so this endpoint also accepts ?key=nod_... Use a dedicated read key.","operationId":"get_dataset_csv_domains__domain__datasets__name__csv_get","parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name"}},{"name":"key","in":"query","required":false,"schema":{"type":"string","default":"","title":"Key"}},{"name":"range","in":"query","required":false,"schema":{"type":"string","description":"7d | 30d | 90d | all","default":"30d","title":"Range"},"description":"7d | 30d | 90d | all"},{"name":"surface","in":"query","required":false,"schema":{"type":"string","description":"Surface key, e.g. chatgpt_app:chat","default":"","title":"Surface"},"description":"Surface key, e.g. chatgpt_app:chat"},{"name":"topic","in":"query","required":false,"schema":{"type":"string","default":"","title":"Topic"}},{"name":"branded","in":"query","required":false,"schema":{"type":"string","description":"unbranded | all | branded","default":"unbranded","title":"Branded"},"description":"unbranded | all | branded"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Bearer nod_...","title":"Authorization"},"description":"Bearer nod_..."}],"responses":{"200":{"description":"Successful Response","content":{"text/plain":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/domains/{domain}/datasets/{name}":{"get":{"summary":"A flat, typed dataset (JSON) for BI tools","operationId":"get_dataset_domains__domain__datasets__name__get","parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","title":"Domain"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name"}},{"name":"range","in":"query","required":false,"schema":{"type":"string","description":"7d | 30d | 90d | all","default":"30d","title":"Range"},"description":"7d | 30d | 90d | all"},{"name":"surface","in":"query","required":false,"schema":{"type":"string","description":"Surface key, e.g. chatgpt_app:chat","default":"","title":"Surface"},"description":"Surface key, e.g. chatgpt_app:chat"},{"name":"topic","in":"query","required":false,"schema":{"type":"string","default":"","title":"Topic"}},{"name":"branded","in":"query","required":false,"schema":{"type":"string","description":"unbranded | all | branded","default":"unbranded","title":"Branded"},"description":"unbranded | all | branded"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Bearer nod_...","title":"Authorization"},"description":"Bearer nod_..."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"NewPrompts":{"properties":{"prompts":{"items":{"type":"string"},"type":"array","maxItems":50,"title":"Prompts","description":"Question texts, 8-500 characters each"},"topic":{"type":"string","title":"Topic","default":""}},"type":"object","required":["prompts"],"title":"NewPrompts"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"servers":[{"url":"/api/v1"}]}