Sign in

v1

latestOpenAPI 3.0.02026-07-26103425558.9 KB
Reporting

Preview Metric Results

Executes a metric calculation on the fly without saving it to the database. Useful for testing parameters or ad-hoc analysis.

post/v2/reporting/metrics/preview

Request body

template'GROSS_VOLUME' | 'TRANSACTION_COUNT' | 'NEW_USERS' required

Metric template name

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: