Docs Sign inGet started
API reference · Metrics

Get a time series

Visibility per run for you and top competitors.

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

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

daysarray

Run dates in the period (YYYY-MM-DD).

linesarray

You first, then up to eight competitors by visibility.

lines[].namestring

The brand.

lines[].youboolean

Whether this line is your brand.

lines[].pointsarray

One rate object per run date, with day.

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