links
GET /v1/link-targets
The Link Tracker report — domains this org's sites link out to.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Идентификатор вашей организации
Этот эндпоинт принимает org_id в качестве параметра запроса. Оставьте его пустым, и вызов охватит все поддерево вашей аренды; передайте его, чтобы сузить область вызова до одной организации.
Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/link-targets \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
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.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
org_id (query) | string | Нет | 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 | Нет | 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> | Нет | own shows only targets that are the customer's own sites; external only those that are not. Omitted shows both. |
site_id (query) | string | Нет | Only targets linked to from this site. |
include_ips (query) | boolean | Нет | Bare-IP targets are real links and are tracked, but they never group sensibly. Set false to hide them. |
min_links (query) | integer | Нет | 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> | Нет | — |
limit (query) | integer | Нет | — |
offset (query) | integer | Нет | — |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
items | LinkTarget[] | Да | — |
total | integer | Да | — |
offset | integer | Да | — |
limit | integer | Да | — |
has_more | boolean | Да | — |
rollup | LinkRollup | Да | 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 | Да | 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. |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 429