visibility

PATCH `/v1/visibility/targets/{targetId}`

Change a watched domain's settings.

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

Updates the label, brand, category, market, cadence or which products watch this domain. `cadence_days: 0` pauses rather than deletes.

Paraméterek

Név	Típus	Kötelező	Mi ez
`targetId (path)`	`Uuid`	Igen	The watched domain's id.

Kérés törzse

Név	Típus	Kötelező	Mi ez
`domain`	`string`	Igen	—
`label`	`string`	Nem	—
`brand`	`string`	Nem	—
`category`	`string`	Nem	—
`market`	`string`	Nem	—
`kinds`	`VisibilityAuditKind[]`	Nem	—
`cadence_days`	`integer`	Nem	—

Válasz

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

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 422

PATCH /v1/visibility/targets/{targetId}