Skip to main content
GET
/
v2
/
reporting
/
templates
/
{name}
GET /v2/reporting/templates/:name
curl --request GET \
  --url https://production.hifibridge.com/v2/reporting/templates/{name} \
  --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"
    ]
  },
  "metadata": {}
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
name
string
required

name parameter

Response

Success

Single template response

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

A metric template definition

​
metadata
object