API Keys & Integrations
API keys let applications and scheduled jobs query your governed metrics outside the Aptrics UI. Integrations push the same semantic definitions into the tools your team already uses, so a metric keeps one meaning wherever it is consumed.
Both are configured per workspace and scoped to the projects and environments they are allowed to reach.
API Keys
Create a Key
From API Keys, create a key with a descriptive name identifying its consumer — reporting-job, customer-portal. The secret is shown once at creation and stored only as a hash, so copy it into your secret manager immediately. A lost key is rotated, not recovered.
Scopes and Expiry
Scope each key to specific projects and environments, and to read or read-write access. Give keys the narrowest scope that works, and set an expiry date so forgotten credentials age out on their own rather than lingering indefinitely.
Authenticate Requests
Send the key as a bearer token on every request:
curl https://api.aptologics.com/v1/metrics \
-H "Authorization: Bearer $APTRICS_API_KEY"Full endpoint documentation lives in the API Reference.
Rotate and Revoke
Rotating issues a new secret while the old one stays valid for a short grace period, so you can deploy without downtime. Revoking takes effect immediately. The key list shows last-used timestamps — anything unused for a long stretch is a candidate for revocation.
Integrations
Semantic Layer Sync
Supported BI and warehouse integrations receive your metric and dimension definitions on a sync, so downstream tools report the same numbers Aptrics does. Syncs run on a schedule or on demand, and the sync history records what was published and any conflicts that blocked it.
Webhooks
Register a webhook to be notified when a model version is promoted, a sync completes, or a connector fails a health check. Payloads are signed with a per-endpoint secret — verify that signature before acting on a delivery.
Notification Channels
Connect email or a chat workspace to route operational alerts — failed refreshes, connector errors, usage thresholds — to the team that owns them rather than to whoever happens to open the app next.