Function getAutomationsUsageMetrics

getAutomationsUsageMetrics(
query: { breakdownBy?: string; filter: string },
options?: ApiCallOptions,
): Promise<GetAutomationsUsageMetricsHttpResponse>
Retrieves paginated usage metrics for automations. The requesting user must be assigned the TenantAdmin role.
Parameters
- query: { breakdownBy?: string; filter: string }
  an object with query parameters
  - OptionalbreakdownBy?: string
    If specified, result will be broken apart for each automation
  - filter: string
    Indicates how the metrics should be filtered using a SCIM-style expression. Available parameters:
    
    name (specify one or more enums to return specific metrics. Supported enum values: runs, scheduledRun, triggeredRun, webhookRuns, duration, bandwidthIn, bandwidthOut)
    
    date (return a metric for a specific date or range of dates, e.g. "2025-08-01")
- Optionaloptions: ApiCallOptions
Returns Promise<GetAutomationsUsageMetricsHttpResponse>
Throws
GetAutomationsUsageMetricsHttpError