Skip to main content
The KPI Integration API lets you programmatically retrieve your company’s campaigns, jobs, and reports.

​
Base URL

All endpoints are versioned under /v1, e.g. https://api.kpi.ms/integration/v1/client/verify.

​
Authentication

The KPI Integration API uses token-based authentication. Include your API key in the Authorization header of every request:

Get an API key

API keys are issued per company by your account manager. Contact them to request one, or to rotate/revoke an existing key.
Use the verify endpoint to confirm a key is active and see which company it belongs to:
Keys can optionally be restricted to specific IPs or domains. A request that doesn’t match a key’s configured restriction is rejected — see Error Handling for the exact error.

​
Headers

All API requests should include:

​
Errors

The KPI Integration API uses standard HTTP status codes to indicate success or failure, plus a JSON error body with a machine-readable error_code. See Error Handling & Rate Limiting for the full list of status codes and error codes.

​
What’s next

  • Error Handling & Rate Limiting — response envelope shapes, status codes, and every error you might encounter.
  • Pagination — how paginated list endpoints work.
  • The endpoints listed below — parameters and example responses are generated directly from the API’s code so they never drift out of date.