v1

latestOpenAPI 3.0.02026-07-26103425558.9 KB
Reporting

Execute Saved Metric

Runs the calculation for an existing saved metric and returns the dataset.

get/v2/reporting/metrics/{id}/results

Path parameters

idstring uuid required

The UUID of the saved metric to execute

Response

Metric calculation results

MetricCalculationResponse required

Response from metric calculation endpoints. The structure of data array items varies based on the breakdowns parameter in the request.

Base structure (no breakdowns):

  • Each item has: periodStart, plus metric-specific fields (e.g., grossVolume, transactionCount)

With breakdowns:

  • Each item includes breakdown dimension fields (e.g., transactionType, transactionStatus, userId)
  • Field names match the breakdown dimension names from the request

Example without breakdowns: