Authorization header. There are no session cookies or OAuth flows for server-to-server calls — your API key is the single credential that identifies your workspace and determines what actions you are allowed to perform.
Generating an API Key
1
Open API Keys settings
Log in to app.canoanalytics.io and navigate to Settings → API Keys.
2
Create a new key
Click Generate Key. Give the key a descriptive name (e.g.,
production-backend or data-pipeline-read) so you can identify it later.3
Select a scope
Choose the minimum scope your integration needs. See Key Scopes below for a description of each option.
4
Copy and store the key securely
The key is shown only once immediately after creation. Copy it and store it in a secrets manager or environment variable — you cannot retrieve it again from the dashboard.
Key Scopes
Scopes follow the principle of least privilege. Grant only the permissions your integration actually needs.A single key can hold multiple scopes. For example, a backend service that both ingests events and reads dashboard data needs both
write and read.Passing Your Key in Requests
Add theAuthorization header to every API request using the Bearer scheme:
Key Naming Conventions
Cano keys are prefixed to indicate their environment at a glance:
Test keys behave identically to live keys but their data is isolated and never mixed with production records. Use test keys in any non-production environment.
Authentication Errors
If your request is rejected due to an authentication or authorization problem, the API returns one of the following errors:
All error responses follow the standard error shape:
Error Response