ads

GET /v1/ads/wordpress/sites

The organisation's WordPress sites connected with the Zinn® Ads plugin.

All ads endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. The key must carry the ads.view permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/ads/wordpress/sites \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Gated on ads.view (docs/1006 §102). Connected sites and pairing codes that have not expired yet. Each site says whether Cloudflare fronts it (cloudflare_detected, measured by the plugin), its tag mode (browser or zaraz), whether to offer Zaraz mode, and in Zaraz mode the purchases sent through Zaraz against what the ad networks credited over the latest tracking-check window (zaraz_health). Cursor-paged newest first: follow page.next_cursor while page.has_more is true (there is no cap on the total).

Parameters

NameTypeRequiredWhat it is
org_id (query)stringNo—
limit (query)integerNoMaximum items to return (page size).
cursor (query)stringNoOpaque cursor from a previous page's page.next_cursor.

Response

NameTypeRequiredWhat it is
dataAdsWordPressSite[]Yes—
pagePageMetaYes—

Errors this endpoint can return

401 · 403 · 429