API

The Ezoic API lets your server call Ezoic services directly over HTTPS, authenticated with a single API key. Turn on the services you want from the API settings page in your dashboard, then call them through the Ezoic API.

Services

Service What it does
Big Data Analytics Query your analytics data: traffic, engagement, and revenue.
CDN Clear and purge cached content.
Subscriptions Verify reader access and read subscriptions server-side.

Looking for an API service you don't see listed here? Contact your account rep — we can enable additional services by request.

Enable API Access

Each service is off until you turn it on:

  1. In your Ezoic dashboard, open the API settings page (Settings → API).
  2. Turn on the service you want to call.
  3. Copy your API key from the same page.

Your API key is unique to your account — one key works for every Ezoic API service you enable. You can regenerate it from the API settings page.

Turning a service on or off only controls whether your key can call it. It never changes how your site runs or what your visitors see.

Base URL

All requests go through the Ezoic API:

https://api-gateway.ezoic.com

Authentication

Every request carries your API key in the X-API-Key header:

X-API-Key: YOUR_API_KEY
The legacy ?developerKey=YOUR_API_KEY query parameter is still accepted on older services so existing integrations keep working, but we recommend integrations use the X-API-Key header. Big Data Analytics v2 accepts only the header.

The API authenticates the key and confirms it is enabled for the service, and that any domain you pass belongs to your account, before the request reaches the service. A key can only ever act on its own domains.