visibility

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

Change a watched domain's settings.

Аутентификация

API кілтін bearer токені ретінде жіберіңіз. Бұл соңғы нүкте сипаттамада арнайы рұқсатты көрсетпейді, сондықтан болжағаннан гөрі кілтіңізге қажетті ең аз рұқсатты беріп, жауапты тексеріңіз.

Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.

Әрекет етіп көру

Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.

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

Жүйеге кіргенсіз бе? Бақылау тақтасындағы API консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған API арқылы орындайды. Бұл соңғы нүктені API консолінде ашыңыз

Мәліметтер

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

Параметрлер

Аты	Tүрі	Міндетті	Мазмұны
`targetId (path)`	`Uuid`	Иә	The watched domain's id.

Сұрау денесі

Аты	Tүрі	Міндетті	Мазмұны
`domain`	`string`	Иә	—
`label`	`string`	Жоқ	—
`brand`	`string`	Жоқ	—
`category`	`string`	Жоқ	—
`market`	`string`	Жоқ	—
`kinds`	`VisibilityAuditKind[]`	Жоқ	—
`cadence_days`	`integer`	Жоқ	—

Жауап

Аты	Tүрі	Міндетті	Мазмұны
`id`	`Uuid`	Иә	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`domain`	`string`	Иә	The hostname
`label`	`string`	Жоқ	The customer's own label for this domain.
`brand`	`string`	Жоқ	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`	Жоқ	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`	Жоқ	Where the business sells. Used with `category` to build the questions.
`is_external`	`boolean`	Иә	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`	Жоқ	The site this target corresponds to, when it is one of ours.
`kinds`	`VisibilityAuditKind[]`	Иә	—
`cadence_days`	`integer`	Иә	Days between scheduled audits. `0` means paused — not deleted. History and settings survive and it resumes with no further action.
`next_due_at`	`string`	Жоқ	—
`last_audit_at`	`string`	Жоқ	—
`review_profiles`	`ReviewProfile[]`	Жоқ	—
`products`	`TrackedProduct[]`	Жоқ	The products this organisation has asked us to price-track.
`merchant_names`	`string[]`	Жоқ	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[]`	Жоқ	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…

Бұл соңғы нүкте қайтара алатын қателер

401 · 403 · 404 · 422

PATCH /v1/visibility/targets/{targetId}