Preview Metric Results

Request to preview a metric calculation without saving

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:

{
  "status": "success",
  "data": [
    { "periodStart": "2025-01-01T00:00:00Z", "grossVolume": 1000.50 },
    { "periodStart": "2025-01-02T00:00:00Z", "grossVolume": 2000.75 }
  ],
  "metadata": { ... }
}

Example with breakdowns: ["transactionType"]:

{
  "status": "success",
  "data": [
    { "periodStart": "2025-01-01T00:00:00Z", "transactionType": "onramp", "grossVolume": 500.25 },
    { "periodStart": "2025-01-01T00:00:00Z", "transactionType": "offramp", "grossVolume": 500.25 }
  ],
  "metadata": { ... }
}