XAxataio
Branches
Metrics

Retrieve branch metrics

Changed on

Returns time-series data for one or more metrics of a branch.

post/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/metrics

Request

  • Base URL
    https://api.xata.tech
  • Auth
    OAuth 2
    Implicit: https://auth.xata.io/realms/xata/protocol/openid-connect/auth
    Scopes: metrics:read

Path parameters

organizationIDstring required
projectIDstring required
branchIDstring required

Request body

startstring date-time required

Start time

endstring date-time required

End time

metricsBranchMetricName[] required

List of metric names to query.

instancesstring[]

List of instance IDs to query

aggregationsstring[] required

List of aggregations to get, this is how the data-points within the interval are aggregated. Each one will generate a separate time-series per metric in the response.

Response

Metrics for a branch

startstring date-time required
endstring date-time required

Changes

  • 4bc5ad58a6c6Revision changes
    • breaking

      the request property's minItems was increased to 1

  • 8d02eb2c8759Revision changes
    • breaking

      the request property became required

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property