elmo
Sign up

Get query fan-out

The searches engines ran while answering this brand's prompts. Engines that don't expose their searches still contribute runs, so `coverageRate` is the honest denominator.

GET
/brands/{brandId}/query-fanout

The searches engines ran while answering this brand's prompts. Engines that don't expose their searches still contribute runs, so coverageRate is the honest denominator.

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/query-fanout?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z"
{  "brandId": "string",  "range": {    "start": "2019-08-24T14:15:22Z",    "end": "2019-08-24T14:15:22Z"  },  "totalQueries": 0,  "uniqueQueries": 0,  "fanoutRuns": 0,  "totalRuns": 0,  "avgQueriesPerRun": 0,  "coverageRate": 0,  "data": [    {      "query": "string",      "runs": 0,      "promptCount": 0    }  ]}