links

GET /v1/content/targets

Which of your sites can receive a post, and why the rest cannot.

Wszystkie punkty końcowe links

Wszystkie dokumentacje dla programistów

Uwierzytelnianie

Wyślij klucz API jako token bearer. Ten punkt końcowy nie określa konkretnego uprawnienia w specyfikacji, więc nadaj swojemu kluczowi minimum potrzebnych uprawnień i sprawdź odpowiedź zamiast zakładać.

Miejsce na identyfikator organizacji

Ten punkt końcowy przyjmuje org_id jako parametr zapytania. Pomiń go, a wywołanie obejmie całe drzewo dzierżawy; prześlij go, aby ograniczyć wywołanie do jednej organizacji.

Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

curl -X GET https://api.zinndigital.com/v1/content/targets \
  -H "Authorization: Bearer zdk_live_…"

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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

NazwaTypWymaganeCo to jest
org_id (query)stringNieNarrow to one organisation in a reseller subtree. Can never widen scope.
q (query)stringNieMatch on domain or site name.
suitability (query)string<ready, needs_setup, unknown, unsuitable, blocked>Nie
product_line (query)stringNie
stack_type (query)stringNie
group_id (query)stringNieOnly sites in this site group.
cms (query)string<wordpress, headless_rest, git_static>NieOnly sites whose target is this kind.
requires (query)stringNieComma-separated capability ids a recipe requires, e.g. cms_target:featured_image,cms_target:category.
limit (query)integerNie
offset (query)integerNie

Odpowiedź

NazwaTypWymaganeCo to jest
itemsSiteTarget[]Tak
totalintegerTakEvery site matching the filters, not the page. This is the number a select-all-matching control shows.
offsetintegerTak
limitintegerTak
has_morebooleanTak

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 422