HIFI Developer Docs

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",
    "transactionDirections": [
      "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",
      "transactionDirections": [
        "onramp",
        "offramp"
      ]
    },
    "createdAt": "2025-12-08T22:26:13.659Z",
    "updatedAt": "2025-12-08T22:26:13.659Z"
  },
  "metadata": {}
}

POST

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",
    "transactionDirections": [
      "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",
      "transactionDirections": [
        "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,

TRANSFERS,

NEW_CUSTOMERS

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.

Show child attributes

params.createdAfter

string<date>

Filter transactions created after this date (ISO 8601)

params.createdBefore

string<date>

Filter transactions created before this date (ISO 8601)

params.calculationInterval

enum<string>

Time interval for aggregation

Available options:

day,

week,

month,

quarter,

year

params.userIds

string<uuid>[]

Filter by specific user IDs

params.transactionDirections

enum<string>[]

Filter by transaction directions

Available options:

onramp,

offramp,

crypto_to_crypto

params.transferStatuses

enum<string>[]

Filter by transfer statuses (for TRANSFERS template)

Available options:

COMPLETED,

FAILED,

PENDING,

CANCELLED

params.breakdowns

enum<string>[]

Dimensions to group results by. Maximum 2 breakdowns allowed. Field names in response data will match these dimension names.

Maximum array length: 2

Available options:

transactionDirection,

transferStatus,

userId

params.limit

integer

default:500

Maximum number of records to return

Required range: 1 <= x <= 500

Response

Metric created successfully

Single metric response

status

enum<string>

Available options:

success

data

object

A saved metric definition

Show child attributes

data.id

string<uuid>

required

Unique metric identifier

data.profileId

string<uuid>

required

Profile ID that owns this metric

data.template

enum<string>

required

Metric template name

Available options:

GROSS_VOLUME,

TRANSFERS,

NEW_CUSTOMERS

data.name

string

required

User-defined metric name

data.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.

Show child attributes

data.params.createdAfter

string<date>

Filter transactions created after this date (ISO 8601)

data.params.createdBefore

string<date>

Filter transactions created before this date (ISO 8601)

data.params.calculationInterval

enum<string>

Time interval for aggregation

Available options:

day,

week,

month,

quarter,

year

data.params.userIds

string<uuid>[]

Filter by specific user IDs

data.params.transactionDirections

enum<string>[]

Filter by transaction directions

Available options:

onramp,

offramp,

crypto_to_crypto

data.params.transferStatuses

enum<string>[]

Filter by transfer statuses (for TRANSFERS template)

Available options:

COMPLETED,

FAILED,

PENDING,

CANCELLED

data.params.breakdowns

enum<string>[]

Dimensions to group results by. Maximum 2 breakdowns allowed. Field names in response data will match these dimension names.

Maximum array length: 2

Available options:

transactionDirection,

transferStatus,

userId

data.params.limit

integer

default:500

Maximum number of records to return

Required range: 1 <= x <= 500

data.createdAt

string<date-time>

required

Creation timestamp

data.updatedAt

string<date-time>

required

Last update timestamp

metadata

object

GET /v2/reporting/params/:name/options

GET /v2/reporting/metrics

⌘I

Overview

Endpoints

POST /v2/reporting/metrics

Authorizations

Body

Response