API Reference

Generate AI Enabler Analytics Data

get
https://api.cast.ai/ai-optimizer/v1beta/organizations/:generateAnalyticsReport

Generates analytics data.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the organization.

Query Params
date-time

Start time for the analytics data.

date-time

End time for the analytics data.

boolean

When true, filters analytics data by the API key owner ID extracted from the auth token.

string

Deprecated: Use filter instead.

string

Deprecated: Use models, castai_api_key_ids, castai_api_key_owner_types, castai_api_key_owner_ids, team_ids, tags instead.

models
array of strings

Filter by model names (e.g., "gpt-4o", "gpt-4o-mini"). Results match any of the listed models.

models
castaiApiKeyIds
array of strings

Filter by CAST AI API key IDs. Results match any of the listed key IDs.

castaiApiKeyIds
castaiApiKeyOwnerTypes
array of strings

Filter by API key owner type ("serviceAccount" or "user"). Results match any of the listed types.

castaiApiKeyOwnerTypes
castaiApiKeyOwnerIds
array of strings

Filter by API key owner IDs. Results match any of the listed owner IDs.

castaiApiKeyOwnerIds
teamIds
array of strings

Filter by team IDs. Results match any of the listed team IDs.

teamIds
tags
array of strings

Filter by request tags. Each entry is "key" or "key:value". Results must match ALL listed tags.

tags
groupBy
array of strings

Dimensions to group the time-series report by. Empty = full cross-product (current default behavior).
Omitting ANALYTICS_GROUP_BY_API_KEY_OWNER collapses owner IDs, so distinct active-user counts
cannot be derived from a coarse response.
Provider is always included in the grouping so self-hosted (vLLM) costs attribute correctly.

groupBy
Allowed:
sections
array of strings

Sections of the report to include in the response. Empty = all sections (current default behavior).
The summary scalars (comparison, stepDuration, mostRecentTime, teamDeleted) are always returned
regardless of this list.

sections
Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?