Introduction - Optimaze

Optimaze exposes HTTP APIs for programmatic access to platform data and integrations. Machine clients authenticate with API keys rather than dashboard login sessions. This reference is generated from our OpenAPI specification and expands as new public endpoints ship.

Base URL

https://api.optimazehq.com

Paths are versioned under /v1/.

Authentication

Send your raw API key in the optimaze-api-key header. Many endpoints also require your organisation ID in the optimaze-org-id header. See Authentication for creating keys, scopes, and security practices.

Available today

Tag	Scope	Endpoint	Purpose
Business metrics	`metrics:ingest`	`POST /v1/metrics/ingest`	Submit metric datapoints

Browse generated endpoint docs under API → API Reference in the sidebar.

Coming soon

Additional tags in the OpenAPI spec, Integrations and Reporting; will gain endpoints as read and management APIs for attribution, cost, and integration data become publicly available. For the business metrics setup workflow, see Business metrics.