OneHazel Docs

Appearance

Platform Metrics & Reporting ​

Monitor your platform's performance with aggregated metrics, per-operator breakdowns, connector adoption statistics, and billing reports.

Summary metrics ​

GET /platform-api/metrics/summary

Returns aggregated KPIs across all operators on your platform.

Example ​

bash
curl https://api.onehazel.com/platform-api/metrics/summary \
  -H "Authorization: Bearer oh_platform_YOUR_KEY"

Typical response fields ​

  • Total operators (active, suspended, total)
  • Total API calls across all operators
  • Total gateway requests
  • Total events ingested
  • Total connections active

Per-operator breakdown ​

GET /platform-api/metrics/operators

Returns metrics broken down by individual operator — useful for identifying your most active operators and those who may need support.

Example ​

bash
curl https://api.onehazel.com/platform-api/metrics/operators \
  -H "Authorization: Bearer oh_platform_YOUR_KEY"

Typical response fields per operator ​

  • Operator name and ID
  • Number of active connections
  • API call volume
  • Event ingestion volume
  • Last active timestamp

Connector adoption ​

GET /platform-api/metrics/connectors

Shows which connectors are being used across your platform and by how many operators.

Example ​

bash
curl https://api.onehazel.com/platform-api/metrics/connectors \
  -H "Authorization: Bearer oh_platform_YOUR_KEY"

Typical response fields per connector ​

  • Connector name and ID
  • Number of operators using it
  • Total connections (active and inactive)
  • Total gateway calls through this connector

Billing report ​

GET /platform-api/usage/report

Generates a usage report for a date range, suitable for invoicing.

Query parameters ​

ParameterTypeDescription
startstringStart date (ISO 8601, e.g. 2026-03-01)
endstringEnd date (ISO 8601, e.g. 2026-03-31)

Example ​

bash
curl "https://api.onehazel.com/platform-api/usage/report?start=2026-03-01&end=2026-03-31" \
  -H "Authorization: Bearer oh_platform_YOUR_KEY"

Typical response ​

The billing report includes per-operator usage breakdowns:

  • API calls by endpoint category
  • Gateway requests by connector
  • Events ingested by type
  • Storage usage
  • Total billable units

Platform settings ​

Get settings ​

GET /platform-api/settings

Returns your platform profile — name, contact details, and configuration.

bash
curl https://api.onehazel.com/platform-api/settings \
  -H "Authorization: Bearer oh_platform_YOUR_KEY"

Update settings ​

PUT /platform-api/settings

Update your platform profile.

bash
curl -X PUT https://api.onehazel.com/platform-api/settings \
  -H "Authorization: Bearer oh_platform_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Platform",
    "contactEmail": "support@myplatform.com",
    "webhookUrl": "https://myplatform.com/webhooks/onehazel"
  }'