API reference · Metrics

Get metrics

Headline metrics with sample sizes and changes.

Ask Claude Ask ChatGPT

GET/api/v1/domains/{domain}/metrics

Path parameters

domainstringRequired

The domain's host, like acme.example, or its ID. List them with List domains.

Query parameters

rangestringdefault 30d

How far back to count: 7d, 30d, 90d or all. The previous period is the same length, just before.

7d30d90dall

surfacestring

Limit to one surface, written engine:lane, e.g. chatgpt_app:chat.

topicstring

Limit to prompts in one topic (exact name).

brandedstringdefault unbranded

Whether to count prompts that name your brand: unbranded (default), all or branded.

unbrandedallbranded

Returns

kpis.visibilityrate object + change

Answers that name you, out of all answers. See Visibility.

kpis.citationsrate object + change

Answers that cite a URL on a domain you own.

kpis.sovobject

Share of voice: k your mentions, n mentions of you and tracked competitors, rate, and prev for the previous period.

kpis.positionobject

avg mean rank where you're named (1 is first), n answers it's based on, top1 answers where you were first, prev the previous period's average.

kpis.sentimentobject

positive, neutral and negative counts of your mentions, out of n.

kpis.answersinteger

Answers counted after filters.

kpis.promptsinteger

Distinct prompts behind them.

kpis.runsinteger

Runs in the period.

surfacesarray

Surfaces with data in the period, as {key, label}. Pass a key back as surface.

topicsarray

Topic names you can pass as topic.

filtersobject

The filters that were applied, after defaults.

Every response includes the domain and the filters that were applied. Errors use the standard error object.

import requests r = requests.get( "https://getonym.com/api/v1/domains/acme.example/metrics", params={'range': '30d'}, headers={"Authorization": "Bearer YOUR_API_KEY"}, ) r.raise_for_status() data = r.json()

{ "domain": "acme.example", "filters": { "range": "30d", "surface": null, "topic": null, "branded": "unbranded" }, "kpis": { "visibility": { "k": 134, "n": 368, "rate": 0.364, "low": 0.317, "high": 0.414, "change": { "delta": 0.188, "significant": true, "direction": "up", "pairs": 92, "prev": { "k": 81, "n": 460, "rate": 0.176, "low": 0.144, "high": 0.214 }, "cur": { "k": 134, "n": 368, "rate": 0.364, "low": 0.317, "high": 0.414 } } }, "citations": { "k": 95, "n": 368, "rate": 0.258, "low": 0.216, "high": 0.305, "change": { "delta": 0.043, "significant": false, "direction": "flat", "pairs": 92, "prev": { "k": 99, "n": 460, "rate": 0.215, "low": 0.18, "high": 0.255 }, "cur": { "k": 95, "n": 368, "rate": 0.258, "low": 0.216, "high": 0.305 } } }, "sov": { "k": 134, "n": 618, "rate": 0.217, "prev": 0.12 }, "position": { "avg": 1.9, "n": 134, "prev": 1.8, "cur_common": 1.9, "top1": 47 }, "sentiment": { "n": 134, "positive": 70, "neutral": 64, "negative": 0 }, "answers": 368, "prompts": 16, "runs": 4 }, "surfaces": [ { "key": "chatgpt_app:chat", "label": "ChatGPT" }, { "key": "openai:coding", "label": "Codex" } ], "topics": [ "Enterprise SSO", "Hosted auth" ] }