visibility

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

Change a watched domain's settings.

Doğrulama

API açarını bearer token kimi göndərin. Bu səhifə spresifikasiyada xüsusi icazə tələb etmir, buna görə də açarınıza ehtiyac duyduğu minimum səviyyədə icazə verin və güman etmək əvəzinə cavabı yoxlayın.

Bu endpoint heç bir təşkilat ID-si tələb etmir. Sizin açarınız artıq aid olduğu təşkilatı müəyyən edir və cavab həmin təşkilat üçün məhdudlaşdırılır.

Sınaqdan keçir

Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.

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

Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın

Təfərrüatlar

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

Parametrlər

Ad	Tip	Tələb olunur	Nədir
`targetId (path)`	`Uuid`	Bəli	The watched domain's id.

Sorğu gövdəsi

Ad	Tip	Tələb olunur	Nədir
`domain`	`string`	Bəli	—
`label`	`string`	Xeyr	—
`brand`	`string`	Xeyr	—
`category`	`string`	Xeyr	—
`market`	`string`	Xeyr	—
`kinds`	`VisibilityAuditKind[]`	Xeyr	—
`cadence_days`	`integer`	Xeyr	—

Cavab

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

Bu son nöqtənin qaytara biləcəyi xətalar

401 · 403 · 404 · 422

PATCH /v1/visibility/targets/{targetId}