HIFI Developer Docs

GET /v2/reporting/metrics

curl --request GET \
  --url https://production.hifibridge.com/v2/reporting/metrics \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "data": [
    {
      "id": "1154d700-bd7d-41d5-8676-87b541baa86e",
      "profileId": "e4c758d7-5475-4505-ba15-e129db0a441f",
      "template": "TRANSFERS",
      "name": "Monthly Transfer Analysis",
      "params": {
        "createdAfter": "2025-01-01",
        "createdBefore": "2025-12-01",
        "calculationInterval": "month"
      },
      "createdAt": "2025-12-08T22:28:03.922Z",
      "updatedAt": "2025-12-08T22:28:03.922Z"
    },
    {
      "id": "d2872dce-d2d1-41ae-87a9-f773adbf97ca",
      "profileId": "e4c758d7-5475-4505-ba15-e129db0a441f",
      "template": "TRANSFERS",
      "name": "Monthly Transfer Analysis",
      "params": {
        "breakdowns": [
          "transactionDirection"
        ],
        "createdAfter": "2025-01-01",
        "createdBefore": "2025-12-01",
        "transferStatuses": [
          "COMPLETED"
        ],
        "calculationInterval": "month",
        "transactionDirections": [
          "onramp",
          "offramp"
        ]
      },
      "createdAt": "2025-12-08T22:26:45.765Z",
      "updatedAt": "2025-12-08T22:26:45.765Z"
    },
    {
      "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": {
    "count": 12,
    "profileId": "e4c758d7-5475-4505-ba15-e129db0a441f"
  }
}

GET

reporting

metrics

GET /v2/reporting/metrics

curl --request GET \
  --url https://production.hifibridge.com/v2/reporting/metrics \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "data": [
    {
      "id": "1154d700-bd7d-41d5-8676-87b541baa86e",
      "profileId": "e4c758d7-5475-4505-ba15-e129db0a441f",
      "template": "TRANSFERS",
      "name": "Monthly Transfer Analysis",
      "params": {
        "createdAfter": "2025-01-01",
        "createdBefore": "2025-12-01",
        "calculationInterval": "month"
      },
      "createdAt": "2025-12-08T22:28:03.922Z",
      "updatedAt": "2025-12-08T22:28:03.922Z"
    },
    {
      "id": "d2872dce-d2d1-41ae-87a9-f773adbf97ca",
      "profileId": "e4c758d7-5475-4505-ba15-e129db0a441f",
      "template": "TRANSFERS",
      "name": "Monthly Transfer Analysis",
      "params": {
        "breakdowns": [
          "transactionDirection"
        ],
        "createdAfter": "2025-01-01",
        "createdBefore": "2025-12-01",
        "transferStatuses": [
          "COMPLETED"
        ],
        "calculationInterval": "month",
        "transactionDirections": [
          "onramp",
          "offramp"
        ]
      },
      "createdAt": "2025-12-08T22:26:45.765Z",
      "updatedAt": "2025-12-08T22:26:45.765Z"
    },
    {
      "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": {
    "count": 12,
    "profileId": "e4c758d7-5475-4505-ba15-e129db0a441f"
  }
}

Authorizations

Authorization

string

header

required

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

Response

Success

List of metrics response

status

enum<string>

Available options:

success

data

object[]

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

Show child attributes

metadata.count

integer

metadata.profileId

string<uuid>

POST /v2/reporting/metrics

GET /v2/reporting/metrics/:id

⌘I

Overview

Endpoints

GET /v2/reporting/metrics

Authorizations

Response