Skip to main content
GET
/
v2
/
reporting
/
templates
GET /v2/reporting/templates
curl --request GET \
  --url https://production.hifibridge.com/v2/reporting/templates \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "data": [
    {
      "template": "GROSS_VOLUME",
      "displayName": "Gross Volume",
      "description": "Total combined USD-equivalent value of completed Onramp and Offramp transactions.",
      "supportedParams": [
        {
          "name": "createdAfter",
          "type": "date",
          "required": true,
          "multiple": false,
          "constraints": {
            "minDate": "2024-07-01",
            "maxDate": "2025-12-08"
          }
        },
        {
          "name": "createdBefore",
          "type": "date",
          "required": true,
          "multiple": false,
          "constraints": {
            "maxDate": "2025-12-08"
          }
        },
        {
          "name": "calculationInterval",
          "type": "enum",
          "required": true,
          "multiple": false,
          "options": [
            "day",
            "week",
            "month"
          ]
        },
        {
          "name": "transactionDirections",
          "type": "enum",
          "required": false,
          "multiple": true,
          "options": [
            "onramp",
            "offramp",
            "onchain"
          ]
        },
        {
          "name": "userIds",
          "type": "uuid",
          "required": false,
          "multiple": true,
          "optionsCount": 1000,
          "optionsTruncated": true,
          "optionsEndpoint": "/reporting/params/userIds/options"
        },
        {
          "name": "breakdowns",
          "type": "enum",
          "required": false,
          "multiple": true,
          "constraints": {
            "maxCount": 2
          }
        },
        {
          "name": "limit",
          "type": "number",
          "required": false,
          "multiple": false,
          "constraints": {
            "min": 1,
            "max": 10000
          }
        }
      ],
      "rules": [
        "createdBefore must be after createdAfter"
      ],
      "breakdownOptions": [
        "transactionDirection",
        "userId"
      ]
    },
    {
      "template": "TRANSFERS",
      "displayName": "Transfers",
      "description": "Aggregated count of transactions grouped by status and direction over time.",
      "supportedParams": [
        {
          "name": "createdAfter",
          "type": "date",
          "required": true,
          "multiple": false,
          "constraints": {
            "minDate": "2024-07-01",
            "maxDate": "2025-12-08"
          }
        },
        {
          "name": "createdBefore",
          "type": "date",
          "required": true,
          "multiple": false,
          "constraints": {
            "maxDate": "2025-12-08"
          }
        },
        {
          "name": "calculationInterval",
          "type": "enum",
          "required": true,
          "multiple": false,
          "options": [
            "day",
            "week",
            "month"
          ]
        },
        {
          "name": "transactionDirections",
          "type": "enum",
          "required": false,
          "multiple": true,
          "options": [
            "onramp",
            "offramp",
            "onchain"
          ]
        },
        {
          "name": "transferStatuses",
          "type": "enum",
          "required": false,
          "multiple": true,
          "options": [
            "AWAITING_FUNDS",
            "FIAT_INITIATED",
            "FIAT_PENDING",
            "FIAT_PROCESSED",
            "CRYPTO_INITIATED",
            "CRYPTO_PENDING",
            "FIAT_FAILED",
            "CRYPTO_FAILED",
            "QUOTE_FAILED",
            "NOT_INITIATED",
            "FIAT_RETURNED",
            "COMPLETED",
            "PENDING_APPROVAL",
            "INITIATED",
            "PENDING",
            "FAILED",
            "REJECTED"
          ]
        },
        {
          "name": "userIds",
          "type": "uuid",
          "required": false,
          "multiple": true,
          "optionsCount": 1000,
          "optionsTruncated": true,
          "optionsEndpoint": "/reporting/params/userIds/options"
        },
        {
          "name": "breakdowns",
          "type": "enum",
          "required": false,
          "multiple": true,
          "constraints": {
            "maxCount": 2
          }
        },
        {
          "name": "limit",
          "type": "number",
          "required": false,
          "multiple": false,
          "constraints": {
            "min": 1,
            "max": 10000
          }
        }
      ],
      "rules": [
        "createdBefore must be after createdAfter"
      ],
      "breakdownOptions": [
        "transactionDirection",
        "transferStatus",
        "userId"
      ]
    },
    {
      "template": "NEW_CUSTOMERS",
      "displayName": "New Customers",
      "description": "Count of new unique end-users onboarded within the time period.",
      "supportedParams": [
        {
          "name": "createdAfter",
          "type": "date",
          "required": true,
          "multiple": false,
          "constraints": {
            "minDate": "2024-07-01",
            "maxDate": "2025-12-08"
          }
        },
        {
          "name": "createdBefore",
          "type": "date",
          "required": true,
          "multiple": false,
          "constraints": {
            "maxDate": "2025-12-08"
          }
        },
        {
          "name": "calculationInterval",
          "type": "enum",
          "required": true,
          "multiple": false,
          "options": [
            "day",
            "week",
            "month"
          ]
        },
        {
          "name": "limit",
          "type": "number",
          "required": false,
          "multiple": false,
          "constraints": {
            "min": 1,
            "max": 10000
          }
        }
      ],
      "rules": [
        "createdBefore must be after createdAfter"
      ],
      "breakdownOptions": null
    }
  ],
  "metadata": {
    "count": 3
  }
}

Authorizations

Authorization
string
header
required

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

Response

Success

List of templates response

status
enum<string>
Available options:
success
data
object[]
metadata
object