Skip to navigation
Pipeline APIMetrics

Fetch account usage metics

Query and fetch usage metrics for the current account.

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Query parameters

fromdatetimeRequired
Define the beginning of the window
todatetimeRequired
Define the end of the window
bucketintegerRequired>=300
Size of the interval represented by each returned metric result
include_deletedbooleanOptionalDefaults to true
Include Pipelines and nodes that have been deleted
pipeline_idstringOptionalformat: "uuid"
Limit usage metrics to the given pipeline id. If not defined, the metrics will include all pipelines for the account.
trafficenumOptional
Limit usage metrics to a single traffic direction. If not defined, the metrics for both directions will be included.
Allowed values:

Response

Default Response