Oviond
Guides

Authentication

API key authentication for the Oviond Integration API

Authentication

All API requests require two headers for authentication and project identification.

Required Headers

HeaderValueDescription
AuthorizationBearer oviond_xxxYour Oviond API key
X-Client-IDCLIENT_IDYour CLIENT ID

Getting an API Key

  1. Log in to the Oviond app
  2. Go to Settings > API Keys
  3. Click Create API Key
  4. Copy the key — it will only be shown once

API keys are prefixed with oviond_ and should be kept secret. Do not expose them in client-side code.

Finding Your Client ID

The X-Client-ID is the CLIENT ID that identifies which project's integrations and credentials to use. You can find this in the Oviond app under your project settings.

Example Request

curl -X POST https://api.oviond.com/v1/integrations/{id}/query \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer oviond_xxx" \
  -H "X-Client-ID: YOUR_CLIENT_ID" \
  -d '{
    "dataView": "default",
    "metrics": ["metric_1", "metric_2"],
    "dateRange": {
      "current": { "startDate": "2025-01-01", "endDate": "2025-01-31" },
      "previous": { "startDate": "2024-12-01", "endDate": "2024-12-31" }
    },
    "timezone": "UTC"
  }'

Testing Your API Key

Validate that your API key and client ID are working:

curl -X POST https://api.oviond.com/v1/integrations/{id}/test \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer oviond_xxx" \
  -H "X-Client-ID: YOUR_CLIENT_ID" \
  -d '{}'

A successful response returns status 200. Failed auth returns status 401 with an error message.

Error Responses

StatusErrorCause
401Missing or invalid Authorization headerNo Authorization header or wrong format
401Invalid API keyAPI key not found or revoked
400Missing X-Client-ID headerNo X-Client-ID header provided