elmo
Sign up

Get a brand's analytics

Visibility, share of voice, the per-model breakdown and the citation totals for one window, in one request. The long lists — cited domains and URLs, sub-queries, per-prompt results — are endpoints of their own. Everything else is always included.

GET
/brands/{brandId}/analytics

Visibility, share of voice, the per-model breakdown and the citation totals for one window, in one request.

The long lists — cited domains and URLs, sub-queries, per-prompt results — are endpoints of their own. Everything else is always included.

Authorization

BearerAuth
AuthorizationBearer <token>

An instance admin key from ADMIN_API_KEYS, or an organization key (elmo_…) issued from the dashboard.

In: header

Path Parameters

brandId*string

Brand identifier.

Query Parameters

start*string

Inclusive lower bound of the window, an ISO 8601 timestamp such as 2026-01-01T00:00:00Z. A bare YYYY-MM-DD is rejected: that is /prompts/{promptId}/snapshot's spelling and means a local calendar day there.

Formatdate-time
end*string

Exclusive upper bound of the window, an ISO 8601 timestamp. The window is half-open: a run at exactly end is outside it.

Formatdate-time
model?string

Restrict to one model, e.g. chatgpt. See GET /models.

tags?string

Comma-separated prompt tags. Only prompts carrying at least one of them are counted.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/brands/string/analytics?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z"
{  "brandId": "string",  "brandName": "string",  "range": {    "start": "2019-08-24T14:15:22Z",    "end": "2019-08-24T14:15:22Z"  },  "visibility": {    "current": 0,    "series": [      {        "date": "2019-08-24",        "visibility": 0      }    ]  },  "shareOfVoice": {    "brand": 0,    "entries": [      {        "name": "string",        "isBrand": true,        "mentions": 0,        "prompts": 0,        "share": 0      }    ],    "series": [      {        "date": "2019-08-24",        "share": 0      }    ]  },  "models": [    {      "model": "string",      "label": "string",      "runs": 0,      "brandMentions": 0,      "visibility": 0,      "citations": 0    }  ],  "totals": {    "runs": 0,    "prompts": 0,    "citations": 0,    "uniqueDomains": 0,    "uniqueUrls": 0  }}