visibility
PUT /v1/visibility/targets/{targetId}/products
Set the products to price-track, and the seller names to look for.
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.
curl -X PUT https://api.zinndigital.com/v1/visibility/targets/{targetId}/products \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
Details
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.
Parameter
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
targetId (path) | Uuid | Ja | The watched domain's id. |
Anfragekörper
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
products | TrackedProduct[] | Nein | — |
merchant_names | string[] | Nein | — |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
domain | string | Ja | The hostname |
label | string | Nein | The customer's own label for this domain. |
brand | string | Nein | 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 | Nein | 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 | Nein | Where the business sells. Used with `category` to build the questions. |
is_external | boolean | Ja | 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 | Nein | The site this target corresponds to, when it is one of ours. |
kinds | VisibilityAuditKind[] | Ja | — |
cadence_days | integer | Ja | Days between scheduled audits. `0` means paused — **not** deleted. History and settings survive and it resumes with no further action. |
next_due_at | string | Nein | — |
last_audit_at | string | Nein | — |
review_profiles | ReviewProfile[] | Nein | — |
products | TrackedProduct[] | Nein | The products this organisation has asked us to price-track. |
merchant_names | string[] | Nein | 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[] | Nein | 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… |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 404 · 422