Home
HomeGuidesRecipesAPI ReferencePython SDKAI Agent SDKAlation Data Quality SDKAlation's MCP Server
HomeAlation Help Center
API Reference
Alation Help Center

Get aggregated usage data.

get
{protocol}://{base-url}/ai/api/v1/usage/aggregated_metrics

Get aggregated usage data for the tenant, with optional filters.

Query Params

Filter by tenant-specific user ID. Server admins can omit to return all users' metrics. Non-admins will only receive their own metrics.

UsageMetricType | null

Filter by metric type (agent, tool, or action). Omit to return all.

UsageProtocol | null

Filter by protocol (http or mcp). Omit to return all.

ProductArea | null

Filter by product area. Omit to return all.

UsageTier | null

Filter by pricing tier (free or paid). Omit to return all.

TimeGranularity | null

Filter by time granularity (hour, day, or month). Omit to return all.

Responses

Updated 3 days ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 3 days ago

Did this page help you?