visibility

PUT /v1/visibility/targets/{targetId}/products

Set the products to price-track, and the seller names to look for.

Všechny koncové body visibility

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ěď.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

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 PUT https://api.zinndigital.com/v1/visibility/targets/{targetId}/products \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

The products and the merchant names are set together because they are only useful together. With products and no seller name we can read the shelf and list who is on it, but we cannot say whether the customer is one of them — the audit reports `product_seller_unknown` and the score is `null`, which is honest rather than a claim that they are missing from Google Shopping. Nothing infers a seller name from the customer's domain. Measured against a live Google Shopping response: every listing carries a `seller` name and a **null** `domain`, so a near-match on a trading name is the only thing a guess could use — and a wrong one would report a stranger's price as the customer's own, on a screen they pay for, with nothing downstream able to detect it. Sending more products than the plan allows is refused with `422` naming the allowance. It is **not** truncated: silently auditing the first ten of two hundred reads as a complete list on the very screen the customer checks.

Parametry

NázevTypPožadovánoCo to je
targetId (path)UuidAnoThe watched domain's id.

Tělo požadavku

NázevTypPožadovánoCo to je
productsTrackedProduct[]Ne
merchant_namesstring[]Ne

Odpověď

NázevTypPožadovánoCo to je
idUuidAnoUUIDv7 identifier — sortable by creation time (docs/02 §8).
domainstringAnoThe hostname
labelstringNeThe customer's own label for this domain.
brandstringNeThe 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…
categorystringNeWhat 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…
marketstringNeWhere the business sells. Used with `category` to build the questions.
is_externalbooleanAnoTrue when this is not a domain hosted with us — a competitor or a prospect. Only external targets count against the plan's allowance.
site_idstringNeThe site this target corresponds to, when it is one of ours.
kindsVisibilityAuditKind[]Ano
cadence_daysintegerAnoDays between scheduled audits. `0` means paused — **not** deleted. History and settings survive and it resumes with no further action.
next_due_atstringNe
last_audit_atstringNe
review_profilesReviewProfile[]Ne
productsTrackedProduct[]NeThe products this organisation has asked us to price-track.
merchant_namesstring[]NeHow 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…
keywordsTrackedKeyword[]NeThe 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…

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422