Hanzo
OpenapiUsage

Echoes a plan's resolved analytics entitlement so a dashboard can configure…

Echoes a plan's resolved analytics entitlement so a dashboard can configure itself against the LIVE catalog instead of hardcoding tier numbers.

GET /v1/usage/analytics/access

Addresshttps://api.hanzo.ai/v1/usage/analytics/access
MethodGET
Operationget_usage_analytics_access
AuthAuthorization: Bearer $HANZO_API_KEY

Echoes a plan's resolved analytics entitlement so a dashboard can configure itself against the LIVE catalog instead of hardcoding tier numbers. An empty plan resolves the free floor, and a catalog resolution failure serves that same floor rather than erroring — so this always answers 200. It is a read-only contract echo and carries no tenant data.

Request

1 field.

FieldInTypeRequiredDescription
planquerystringPlan is a plan id from the live @hanzo/plans catalog.

Response

StatusBodyMeaning
200usageAnalyticsAccessok

200 body — 5 fields.

FieldInTypeAlwaysDescription
accessbodyusageAnalyticsGrant
access.datastorebodybooleanDatastore is whether the plan may read GET /v1/usage/analytics at all.
access.exportbodybooleanExport is whether the plan may export the analytics it can read.
access.retentionDaysbodyintegerRetentionDays is how far back the plan may read.
planbodystringPlan echoes the plan id that was resolved, exactly as it was asked for.

Failure carries the platform error shape — see Errors.

Examples

hanzo usage analytics access

Usage API · All Hanzo APIs · Interactive reference

How is this guide?

On this page