links
GET /v1/content/targets/facets
Filter counts over the whole matching set, not the current page.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
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/content/targets/facets \
-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
Counts per suitability, product line, CMS and site group, computed over **every** site matching the current filters. Gated on `links.view`. ⭐ This is what makes "select all 214 matching" a number a customer can trust rather than an extrapolation from the 50 rows on screen. It accepts the same filter parameters as `listContentTargets`. ⛔ The `unknown` count **includes every site that has never been probed**. A facet that counted only stored rows would report `unknown: 0` on an estate where nothing had been checked — a blind instrument reporting that everything is fine.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | — |
q (query) | string | No | — |
suitability (query) | string<ready, needs_setup, unknown, unsuitable, blocked> | No | — |
product_line (query) | string | No | — |
stack_type (query) | string | No | — |
group_id (query) | string | No | — |
cms (query) | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
total | integer | Yes | — |
suitability | ContentTargetFacetCount[] | Yes | — |
product_line | ContentTargetFacetCount[] | Yes | — |
cms | ContentTargetFacetCount[] | Yes | — |
group | ContentTargetFacetCount[] | Yes | — |
Errors this endpoint can return
401 · 403