API reference · Prompts

List prompts

Prompt set with per-prompt performance.

Ask Claude Ask ChatGPT

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

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

promptsarray

Every prompt on the domain: active, then suggested, then archived.

prompts[].idstring

The prompt's ID.

prompts[].statusstring

active (asked every run), suggested (not asked yet) or archived.

prompts[].sourcestring

library, generated or custom.

prompts[].lanesarray

chat, coding or both.

prompts[].visibilityrate object or null

How often answers to this prompt name you.

prompts[].changechange object or null

Compared with the previous period.

prompts[].avg_positionnumber or null

Your average rank on this prompt.

prompts[].top_competitorobject or null

The competitor named most often, as {name, rate}.

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

{ "domain": "acme.example", "filters": { "range": "30d", "surface": null, "topic": null, "branded": "unbranded" }, "prompts": [ { "id": "14686699-b479-4cf1-9b02-c9232ae704bc", "text": "Best auth provider for a B2B app that needs SAML SSO and SCIM", "topic": "Enterprise SSO", "status": "active", "source": "custom", "lanes": [ "chat", "coding" ], "visibility": { "k": 10, "n": 28, "rate": 0.357, "low": 0.207, "high": 0.542 }, "change": { "delta": 0.186, "significant": false, "direction": "flat", "pairs": 7, "prev": { "k": 6, "n": 35, "rate": 0.171, "low": 0.081, "high": 0.327 }, "cur": { "k": 10, "n": 28, "rate": 0.357, "low": 0.207, "high": 0.542 } }, "avg_position": 1.8, "top_competitor": { "name": "Northwind", "rate": 0.536 } }, { "id": "67770123-1cb8-4f00-9eb7-a751cc638aa1", "text": "How do I add enterprise SSO to my SaaS quickly?", "topic": "Enterprise SSO", "status": "active", "source": "custom", "lanes": [ "chat" ], "visibility": { "k": 11, "n": 20, "rate": 0.55, "low": 0.342, "high": 0.742 }, "change": { "delta": 0.43, "significant": true, "direction": "up", "pairs": 5, "prev": { "k": 3, "n": 25, "rate": 0.12, "low": 0.042, "high": 0.3 }, "cur": { "k": 11, "n": 20, "rate": 0.55, "low": 0.342, "high": 0.742 } }, "avg_position": 2.4, "top_competitor": { "name": "Northwind", "rate": 0.55 } } ] }