Autenticação
Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X POST https://api.zinndigital.com/v1/visibility/targets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "domain": <string> }'Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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.
Corpo da requisição
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
domain | string | Sim | — |
label | string | Não | — |
brand | string | Não | — |
category | string | Não | — |
market | string | Não | — |
kinds | VisibilityAuditKind[] | Não | — |
cadence_days | integer | Não | — |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
id | Uuid | Sim | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
domain | string | Sim | The hostname |
label | string | Não | The customer's own label for this domain. |
brand | string | Não | 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 | Não | 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 | Não | Where the business sells. Used with `category` to build the questions. |
is_external | boolean | Sim | 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 | Não | The site this target corresponds to, when it is one of ours. |
kinds | VisibilityAuditKind[] | Sim | — |
cadence_days | integer | Sim | Days between scheduled audits. `0` means paused — **not** deleted. History and settings survive and it resumes with no further action. |
next_due_at | string | Não | — |
last_audit_at | string | Não | — |
review_profiles | ReviewProfile[] | Não | — |
products | TrackedProduct[] | Não | The products this organisation has asked us to price-track. |
merchant_names | string[] | Não | 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[] | Não | 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… |
Erros que este endpoint pode retornar
401 · 403 · 422