links
GET /v1/link-targets
The Link Tracker report — domains this org's sites link out to.
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/link-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
V1's columns, rebuilt: Domain | Site | Reflinks | Ref posts | Ref sites. Ranked by reflinks by default, because the question is "who am I linking to most". Search rolls variants up. www., letter case and punycode/Unicode are folded on the write path, so they are already one row by the time you search — that is the fix for the production defect where cu-tv.com showed 185 reflinks and www.cu-tv.com showed 1 (docs/96 §1.4, D1328). Subdomains stay separate rows, because an operator cares which host they hit, but a search for skokka.com finds blog.skokka.com too and rollup gives the combined totals across the whole match. ⛔ Paged by offset, not by cursor. The shared cursor paginator is keyset over the sortable id, which is chronological; this list is ranked, and a keyset cursor cannot express that ordering. total is the full match so the screen can page all of it — there is no hidden cap. coverage says how much of the estate the report is based on. ⛔ Without it a customer cannot tell "no outbound links" from "nobody has scanned this yet", and those two readings lead to opposite actions.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
org_id (query) | string | Ne | Narrow to one organisation in the caller's subtree — what the dashboard's org switcher sends. ⛔ Narrow only: it is intersected with what the caller may already read, so an org… |
q (query) | string | Ne | A domain, or any text. A value that parses as a hostname matches that host and every subdomain of it; anything else is a substring match, because someone typing casino means… |
owned (query) | string<own, external> | Ne | own shows only targets that are the customer's own sites; external only those that are not. Omitted shows both. |
site_id (query) | string | Ne | Only targets linked to from this site. |
include_ips (query) | boolean | Ne | Bare-IP targets are real links and are tracked, but they never group sensibly. Set false to hide them. |
min_links (query) | integer | Ne | The noise filter. Padding links (google.com, youtube.com) sit beside the money links deliberately. ⛔ They are filterable, never auto-deleted — removing a link a customer… |
sort (query) | string<links, posts, sites, host, recent> | Ne | — |
limit (query) | integer | Ne | — |
offset (query) | integer | Ne | — |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
items | LinkTarget[] | Ano | — |
total | integer | Ano | — |
offset | integer | Ano | — |
limit | integer | Ano | — |
has_more | boolean | Ano | — |
rollup | LinkRollup | Ano | Combined totals across every target the filters matched — the "including variants of it" number. Not the sum of the page, so it does not change as you page. |
coverage | LinkCoverage | Ano | How much of the estate the report is based on. ⛔ Without it a customer cannot tell "no outbound links" from "never scanned", and those lead to opposite actions. |
Chyby, které může tento koncový bod vrátit
401 · 403 · 429