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": "transactionTypes",
"type": "enum",
"required": false,
"multiple": true,
"options": [
"onramp",
"offramp",
"transfer"
]
},
{
"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": [
"transactionType",
"transactionStatus",
"userId"
]
},
"metadata": {}
}Returns the specific definition for a template, including its description, the list of fields you can pass as parameters, and the dimensions available for breakdowns.
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": "transactionTypes",
"type": "enum",
"required": false,
"multiple": true,
"options": [
"onramp",
"offramp",
"transfer"
]
},
{
"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": [
"transactionType",
"transactionStatus",
"userId"
]
},
"metadata": {}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The name of the metric template (e.g., GROSS_VOLUME, TRANSACTION_COUNT, NEW_USERS)