visibility

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

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

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X PUT https://api.zinndigital.com/v1/visibility/targets/{targetId}/products \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

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.

Parameters

Name	Type	Required	What it is
`targetId (path)`	`Uuid`	Yes	The watched domain's id.

Request body

Name	Type	Required	What it is
`products`	`TrackedProduct[]`	No	—
`merchant_names`	`string[]`	No	—

Response

Name	Type	Required	What it is
`id`	`Uuid`	Yes	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`domain`	`string`	Yes	The hostname
`label`	`string`	No	The customer's own label for this domain.
`brand`	`string`	No	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`	No	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`	No	Where the business sells. Used with `category` to build the questions.
`is_external`	`boolean`	Yes	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`	No	The site this target corresponds to, when it is one of ours.
`kinds`	`VisibilityAuditKind[]`	Yes	—
`cadence_days`	`integer`	Yes	Days between scheduled audits. `0` means paused — not deleted. History and settings survive and it resumes with no further action.
`next_due_at`	`string`	No	—
`last_audit_at`	`string`	No	—
`review_profiles`	`ReviewProfile[]`	No	—
`products`	`TrackedProduct[]`	No	The products this organisation has asked us to price-track.
`merchant_names`	`string[]`	No	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[]`	No	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…

Errors this endpoint can return

401 · 403 · 404 · 422

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