Autentifikatsiya
API kalitini bearer token sifatida yuboring. Ushbu yakuniy nuqta spetsifikatsiyada ma'lum bir ruxsatni ko'rsatmaydi, shuning uchun kalitingizga eng kam kerakli huquqni bering va taxmin qilish o'rniga javobni tekshiring.
Bu yakuniy nuqta hech qanday tashkilot identifikatorini qabul qilmaydi. Sizning kalitingiz unga tegishli tashkilotni allaqachon aniqlaydi va javob shunga qarab cheklanadi.
Sinab ko'rish
Qavslardagi har qanday narsani o'z qiymatlaringiz bilan, kalit pleysxolderini эsa boshqaruv panelingizdagi kalit bilan almashtiring.
curl -X POST https://api.zinndigital.com/v1/visibility/targets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "domain": <string> }'Tizimga kirganmisiz? Boshqaruv panelingizdagi API konsoli haqiqiy tashkilot ID raqamingiz va shaxsiy kalitingizni avtomatik to'ldiradi hamda haqiqiy javobni ko'rishingiz uchun so'rovni jonli API orqali bajaradi. Ushbu yakuniy nuqtani API konsolida oching
Tafsilotlar
Adds a domain to the watch-list. A domain that is **not** hosted with us counts against the external-target allowance; the organisation's own sites do not. `category` and `market` decide what questions the answer engines are asked, and are the single most important thing a customer can supply — a reading taken on defaults is real and is worth less. `brand` is the trading name to look for in an answer, which is genuinely separate from the domain: a model that recommends a business by name without printing its URL has still mentioned them. `cadence_days: 0` pauses the schedule. It does **not** delete anything: history and settings survive and it resumes with no further action.
Soʻrov tanasi
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
domain | string | Ha | — |
label | string | Yo'q | — |
brand | string | Yo'q | — |
category | string | Yo'q | — |
market | string | Yo'q | — |
kinds | VisibilityAuditKind[] | Yo'q | — |
cadence_days | integer | Yo'q | — |
Javob
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
id | Uuid | Ha | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
domain | string | Ha | The hostname |
label | string | Yo'q | The customer's own label for this domain. |
brand | string | Yo'q | 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 | Yo'q | 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 | Yo'q | Where the business sells. Used with `category` to build the questions. |
is_external | boolean | Ha | 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 | Yo'q | The site this target corresponds to, when it is one of ours. |
kinds | VisibilityAuditKind[] | Ha | — |
cadence_days | integer | Ha | Days between scheduled audits. `0` means paused — **not** deleted. History and settings survive and it resumes with no further action. |
next_due_at | string | Yo'q | — |
last_audit_at | string | Yo'q | — |
review_profiles | ReviewProfile[] | Yo'q | — |
products | TrackedProduct[] | Yo'q | The products this organisation has asked us to price-track. |
merchant_names | string[] | Yo'q | 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[] | Yo'q | 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… |
Ushbu yakuniy nuqta qaytarishi mumkin bo'lgan xatolar
401 · 403 · 422