Metrics

Get usage graph over time

post/v3/subscriptions/metrics/{organizationName}/current-usage-graph

Request

  • Base URL: https://api.zephyr-cloud.io
  • URL: https://api.zephyr-cloud.io/v3/subscriptions/metrics/{organizationName}/current-usage-graph
  • Auth: HTTP bearer

Path parameters

organizationNamestring required

Organization name

Example:my-org

Request body

metricsstring[] nullable

Metrics to include in the graph

startstring date-time

Start date for the graph

endstring date-time

End date for the graph

span'hour' | 'day' | 'week' | 'month' | 'year'

Time span for aggregation

Example request

{
  "metrics": [
    "DEPLOYMENTS"
  ],
  "start": "2025-01-01T00:00:00.000Z",
  "end": "2025-01-31T23:59:59.999Z",
  "span": "day"
}

Response

Graph data

metric'DEPLOYMENTS' required

The metric type

usednumber nullable required

Usage value for this data point

datestring date-time nullable required

Date of this data point

Example response

[
  {
    "metric": "DEPLOYMENTS",
    "used": 150,
    "date": "2025-01-15T00:00:00.000Z"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.