visibility
PATCH /v1/visibility/targets/{targetId}
Change a watched domain's settings.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.
Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X PATCH https://api.zinndigital.com/v1/visibility/targets/{targetId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "domain": <string> }'Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
Updates the label, brand, category, market, cadence or which products watch this domain. `cadence_days: 0` pauses rather than deletes.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
targetId (path) | Uuid | Так | The watched domain's id. |
Тіло запиту
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
domain | string | Так | — |
label | string | Ні | — |
brand | string | Ні | — |
category | string | Ні | — |
market | string | Ні | — |
kinds | VisibilityAuditKind[] | Ні | — |
cadence_days | integer | Ні | — |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
id | Uuid | Так | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
domain | string | Так | The hostname |
label | string | Ні | The customer's own label for this domain. |
brand | string | Ні | The trading name to look for in an answer engine's reply. Genuinely separate from the domain — an answer that recommends a business by name without printing its URL has still me… |
category | string | Ні | What this business sells, in the customer's own words. The questions asked of the answer engines are built from it, so it is the single field that decides whether an AI-visibili… |
market | string | Ні | Where the business sells. Used with `category` to build the questions. |
is_external | boolean | Так | True when this is not a domain hosted with us — a competitor or a prospect. Only external targets count against the plan's allowance. |
site_id | string | Ні | The site this target corresponds to, when it is one of ours. |
kinds | VisibilityAuditKind[] | Так | — |
cadence_days | integer | Так | Days between scheduled audits. `0` means paused — **not** deleted. History and settings survive and it resumes with no further action. |
next_due_at | string | Ні | — |
last_audit_at | string | Ні | — |
review_profiles | ReviewProfile[] | Ні | — |
products | TrackedProduct[] | Ні | The products this organisation has asked us to price-track. |
merchant_names | string[] | Ні | How this business appears as a **seller** on the marketplaces. Confirmed by the customer and never inferred: Google Shopping publishes a seller name and no domain on its listing… |
keywords | TrackedKeyword[] | Ні | The search phrases this organisation tracks its position for. Customer-supplied and never derived: asking a vendor which phrases a domain already ranks for would return exactly… |
Помилки, які може повертати ця кінцева точка
401 · 403 · 404 · 422