Analytics APIAnalytics SaaS

Getprompttemplateentities

View as Markdown
Entity-level statistics for one prompt template over a calendar period. `entity_ids` is a comma-separated list. If omitted or empty, the server returns an empty `entities` array. **Success `data`:** `{ "entities": [{ "entity_id", "entity_type", "total_calls", "cost_sum" }] }`.

Authentication

AuthorizationBearer
Bearer credential containing a JWT, Virtual Key, or PAT.

Path parameters

prompt_idstringRequired
Prompt template id.

Headers

X-Workspace-IdstringOptionalformat: "uuid"

Required for a normal JWT, Virtual Key, or PAT. A JWT may instead send X-Openmodel-User-Id. Not used by the public health endpoint.

X-Openmodel-User-IdstringOptionalformat: "uuid"

JWT-only alternative to X-Workspace-Id. Must be a UUID equal to the JWT subject; the server uses it as the workspace id. Not valid as the sole workspace header for Virtual Key or PAT authentication.

Query parameters

dateFromstringRequired

Inclusive start YYYY-MM-DD.

dateTostringRequired

Inclusive end YYYY-MM-DD.

entity_idsstringOptional

Comma-separated entity ids.

Response

codeinteger
messagestring
dataany