Skip to main content
POST
/
v2
/
reporting
/
metrics
curl --request POST \
  --url https://production.hifibridge.com/v2/reporting/metrics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "template": "GROSS_VOLUME",
  "name": "Daily Revenue Report",
  "params": {
    "createdAfter": "2025-11-01",
    "createdBefore": "2025-11-07",
    "calculationInterval": "day",
    "transactionTypes": [
      "onramp",
      "offramp"
    ]
  }
}
'
{
  "status": "success",
  "data": {
    "id": "9106f8e2-188f-4854-99fc-cb21ef6b998d",
    "profileId": "e4c758d7-5475-4505-ba15-e129db0a441f",
    "template": "GROSS_VOLUME",
    "name": "Daily Revenue Report",
    "params": {
      "createdAfter": "2025-11-01",
      "createdBefore": "2025-11-07",
      "calculationInterval": "day",
      "transactionTypes": [
        "onramp",
        "offramp"
      ]
    },
    "createdAt": "2025-12-08T22:26:13.659Z",
    "updatedAt": "2025-12-08T22:26:13.659Z"
  },
  "metadata": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request to create a new saved metric

​
template
enum<string>
required

Metric template name

Available options:
GROSS_VOLUME,
TRANSACTION_COUNT,
NEW_USERS
​
name
string
required

User-defined metric name

Required string length: 1 - 100
​
params
object
required

Metric parameters. Structure varies by template, but common fields include:

  • Date range filters
  • Calculation interval
  • Breakdown dimensions
  • Template-specific filters

Additional properties may be present based on the metric template. Each template may define template-specific parameters.

​
description
string | null

Optional description for the metric

Maximum string length: 500

Response

Metric created successfully

Single metric response

​
status
enum<string>
Available options:
success
​
data
object

A saved metric definition

​
metadata
object