v1

latestOpenAPI 3.0.02026-08-04181876.9 KB

automations

Get automation usage metrics

Retrieves paginated usage metrics for automations. The requesting user must be assigned the TenantAdmin or AnalyticsAdmin role.

get/api/v1/automations/usage

Query parameters

filterstring required

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, scheduledRuns, triggeredRuns, webhookRuns, duration, bandwidthIn, bandwidthOut)
date (return a metric for a specific date or range of dates, e.g. "2025-08-01")

breakdownBystring

Example:automation

If specified, result will be broken apart for each automation

Response

OK Response

Example response

{
  "data": [
    {
      "date": "2021-12-15",
      "name": "bandwidthIn",
      "value": 310179713,
      "automation": {
        "guid": "00000000-0000-0000-0000-000000000000",
        "name": "My Automation.",
        "ownerId": "KP1zJiPDn0gsla236GmETadFcxBW-J8F"
      }
    }
  ]
}