links
GET /v1/content/targets
Which of your sites can receive a post, and why the rest cannot.
Autentizace
Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.
Sem patří ID vaší organizace
Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.
ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X GET https://api.zinndigital.com/v1/content/targets \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
Every live site in scope with its suitability: can it take an article, and — when it cannot — whose fact that is. Gated on links.view. ⛔⛔ suitability has five values and the difference between two of them is the whole point of this endpoint. unsuitable is measured: every adapter was asked which sites it claims and each one declined, so this kind of site genuinely has nowhere to put an article. unknown means we could not determine it — the box was unreachable, the credential has never been tested, or nothing has checked this site yet. A client MUST NOT render unknown as a refusal, MUST NOT silently exclude it from a selection, and SHOULD count it separately in any confirmation ("9 ready, 3 unchecked"). Treating "we could not look" as "no" is the defect this endpoint exists to prevent. ⛔ This endpoint makes no outbound calls. Suitability is served from the last stored probe with checkedAt beside it, because probing every row of a 500-site page would be an uncached external call in an interactive path. checkedAt: null means never checked and MUST be shown as such, not as a fresh result. Use probeContentTargets to refresh. ⭐ requires takes capability ids a recipe needs; each row then carries missingCapabilities, so an editor can grey a site out and say what it cannot do. A site whose capabilities are not established reports nothing missing rather than everything missing — for the same reason unknown is not unsuitable.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
org_id (query) | string | Ne | Narrow to one organisation in a reseller subtree. Can never widen scope. |
q (query) | string | Ne | Match on domain or site name. |
suitability (query) | string<ready, needs_setup, unknown, unsuitable, blocked> | Ne | — |
product_line (query) | string | Ne | — |
stack_type (query) | string | Ne | — |
group_id (query) | string | Ne | Only sites in this site group. |
cms (query) | string<wordpress, headless_rest, git_static> | Ne | Only sites whose target is this kind. |
requires (query) | string | Ne | Comma-separated capability ids a recipe requires, e.g. cms_target:featured_image,cms_target:category. |
limit (query) | integer | Ne | — |
offset (query) | integer | Ne | — |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
items | SiteTarget[] | Ano | — |
total | integer | Ano | Every site matching the filters, not the page. This is the number a select-all-matching control shows. |
offset | integer | Ano | — |
limit | integer | Ano | — |
has_more | boolean | Ano | — |
Chyby, které může tento koncový bod vrátit
401 · 403 · 422