curl --request GET \
--url https://production.hifibridge.com/v2/reporting/templates \
--header 'Authorization: Bearer <token>'{
"status": "success",
"data": [
{
"name": "<string>",
"displayName": "<string>",
"description": "<string>",
"params": [
{
"name": "<string>",
"type": "date",
"required": true,
"description": "<string>",
"options": "<array>",
"constraints": {}
}
],
"supportsBreakdowns": true,
"breakdownOptions": [
"<string>"
]
}
],
"metadata": {
"count": 123
}
}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": [
{
"name": "<string>",
"displayName": "<string>",
"description": "<string>",
"params": [
{
"name": "<string>",
"type": "date",
"required": true,
"description": "<string>",
"options": "<array>",
"constraints": {}
}
],
"supportsBreakdowns": true,
"breakdownOptions": [
"<string>"
]
}
],
"metadata": {
"count": 123
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Success
List of templates response
success Show child attributes
Template identifier
Human-readable template name
Template description
Available parameters for this template
Show child attributes
Parameter name
Parameter data type
date, string, array, enum, integer Whether this parameter is required
Parameter description
Available options (for enum/array types)
Validation constraints (e.g., min, max, maxItems)
Whether this template supports breakdown dimensions
Available breakdown dimensions for this template