Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hifi Reporting API

Reporting and metrics endpoints

Hifi Reporting API is one of 15 APIs that Hifi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Reporting. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 7 paths, and defines 16 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.

Requests are made against 2 base URLs: https://production.hifibridge.com, https://sandbox.hifibridge.com.

10 operations 7 paths 16 schemas 1 DELETE6 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.0
Base URL
https://production.hifibridge.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Hifi Reporting API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 10

Across 7 paths, the API surfaces 10 operations — 1 DELETE, 6 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Reporting 10

Reporting and metrics endpoints

GET
/v2/reporting/templates
Get Available Metric Templates
→ 200400401404500
GET
/v2/reporting/templates/{name}
Get Template Details
1 param → 200400401404500
GET
/v2/reporting/params/{name}/options
Get Parameter Options
3 params → 200400401404500
POST
/v2/reporting/metrics
Create Saved Metric
body → 201400401404500
GET
/v2/reporting/metrics
List Saved Metrics
→ 200400401404500
GET
/v2/reporting/metrics/{id}
Get Metric Details
1 param → 200400401404500
POST
/v2/reporting/metrics/{id}
Update Saved Metric
1 param body → 200400401404500
DELETE
/v2/reporting/metrics/{id}
Delete Saved Metric
1 param → 200400401404500
POST
/v2/reporting/metrics/preview
Preview Metric Results
body → 200400401404500
GET
/v2/reporting/metrics/{id}/results
Execute Saved Metric
1 param → 200400401404500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are MetricCalculationMetadata (9 properties), MetricParams (8 properties), Metric (7 properties), MetricTemplate (6 properties). Each schema is shown below with its type and property counts.

UpdateMetricRequest
object
Request to update an existing metric
2 properties
PreviewMetricRequest
object
Request to preview a metric calculation without saving
2 properties 2 required
TemplateListResponse
object
List of templates response
3 properties
InternalServerError
object
1 property
Metric
object
A saved metric definition
7 properties 7 required
CreateMetricRequest
object
Request to create a new saved metric
3 properties 3 required
MetricResponse
object
Single metric response
3 properties
Unauthorized
object
1 property
ParamOptionsResponse
object
Paginated list of parameter options
3 properties
MetricListResponse
object
List of metrics response
3 properties
MetricCalculationResponse
object
Response from metric calculation endpoints. The structure of data array items varies based on the breakdowns parameter in the request. Base structure (no break…
3 properties
TemplateResponse
object
Single template response
3 properties
MetricParamDefinition
object
Definition of a metric parameter
6 properties
MetricParams
object
Metric parameters. Structure varies by template, but common fields include: - Date range filters - Calculation interval - Breakdown dimensions - Template-speci…
8 properties
MetricTemplate
object
A metric template definition
6 properties
MetricCalculationMetadata
object
Metadata about the metric calculation
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hifi-reporting-api-openapi.yml Raw ↑

Other APIs Hifi publishes across the network.

Hifi Account API
Hifi Common API
Hifi Cross-Chain Bridge API
Hifi Crypto Transfer API
Hifi File API
Hifi Kyc API
Hifi Offramp API
Hifi Onramp API
Hifi Settlement Rules API
Hifi Token Swap API
Hifi Transfer Approvals API
Hifi User API