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": "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"
]
},
{
"template": "TRANSACTION_COUNT",
"displayName": "Transaction Count",
"description": "Aggregated count of transactions grouped by status and type 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": "transactionTypes",
"type": "enum",
"required": false,
"multiple": true,
"options": [
"onramp",
"offramp",
"transfer"
]
},
{
"name": "transactionStatuses",
"type": "enum",
"required": false,
"multiple": true,
"options": [
"AWAITING_FUNDS",
"COMPLETED",
"CRYPTO_FAILED",
"CRYPTO_INITIATED",
"CRYPTO_PENDING",
"FAILED",
"FIAT_FAILED",
"FIAT_INITIATED",
"FIAT_PENDING",
"FIAT_PROCESSED",
"FIAT_RETURNED",
"INITIATED",
"NOT_INITIATED",
"PENDING",
"QUOTE_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": [
"transactionType",
"transactionStatus",
"userId"
]
},
{
"template": "NEW_USERS",
"displayName": "New Users",
"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
}
}Retrieves a list of all available metric templates (e.g., GROSS_VOLUME, TRANSACTION_COUNT). Templates define the logic, supported parameters, and breakdown options available for building reports.
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": "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"
]
},
{
"template": "TRANSACTION_COUNT",
"displayName": "Transaction Count",
"description": "Aggregated count of transactions grouped by status and type 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": "transactionTypes",
"type": "enum",
"required": false,
"multiple": true,
"options": [
"onramp",
"offramp",
"transfer"
]
},
{
"name": "transactionStatuses",
"type": "enum",
"required": false,
"multiple": true,
"options": [
"AWAITING_FUNDS",
"COMPLETED",
"CRYPTO_FAILED",
"CRYPTO_INITIATED",
"CRYPTO_PENDING",
"FAILED",
"FIAT_FAILED",
"FIAT_INITIATED",
"FIAT_PENDING",
"FIAT_PROCESSED",
"FIAT_RETURNED",
"INITIATED",
"NOT_INITIATED",
"PENDING",
"QUOTE_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": [
"transactionType",
"transactionStatus",
"userId"
]
},
{
"template": "NEW_USERS",
"displayName": "New Users",
"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
}
}