API reference · Datasets

Get a dataset

A flat, typed dataset (JSON) for BI tools.

Ask Claude Ask ChatGPT

GET/api/v1/domains/{domain}/datasets/{name}

Path parameters

domainstringRequired

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

namestringRequired

The dataset: visibility, prompts, sources or answers.

visibilitypromptssourcesanswers

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

fieldsarray

Column names and types (date, text, bool, int, float).

rowsarray

Rows as arrays, in the order of fields.

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/datasets/visibility", headers={"Authorization": "Bearer YOUR_API_KEY"}, ) r.raise_for_status() data = r.json()

{ "domain": "acme.example", "dataset": "visibility", "filters": { "range": "30d", "surface": null, "topic": null, "branded": "unbranded" }, "fields": [ { "name": "run_date", "type": "date" }, { "name": "surface", "type": "text" } ], "rows": [ [ "2026-09-20", "ChatGPT" ], [ "2026-09-20", "ChatGPT" ] ] }