Skip to main content
GET
Get pipeline usage metrics for all child organizations of an enterprise

Authorizations

Authorization
string
header
required

The primary authentication method for the Mezmo API.

Pass the key in the Authorization header in the format Token <ACCESS TOKEN>. For example:

This key is used for all APIs with the exception of ingest.

Query Parameters

from
string<date-time>
required

Define the beginning of the window

to
string<date-time>
required

Define the end of the window

bucket
integer
required

Size of the interval represented by each returned metric result

include_deleted
boolean
default:true

Include pipelines and nodes that have been deleted

pipeline_id
string<uuid>

Limit usage metrics to the given pipeline id. If not defined, the metrics will include all pipelines for the account.

traffic
enum<string>

Limit usage metrics to a single traffic direction. If not defined, the metrics for both directions will be included.

Available options:
ingress,
egress

Response

Response containing pipeline usage metrics for all child orgs of the enterprise

Response containing pipeline usage metrics for all child orgs of the enterprise

meta
object
required

Contains additional contextual information about the api response.

data
PipelineMetricUsage · object[]
required