visibility

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

Change a watched domain's settings.

تصدیق‌هویت

د بیارر ټوکن په توګه یو API کي وسپارئ. دا پای ټکی په مشخصاتو کې کوم ځانګړی اجازه لیک نه بیانوي، نو خپل کیلي ته لږترلږه هغه څه ورکړئ چې ورته اړتیا لري او د فرض کولو پر ځای ځواب وپلټئ.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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 کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د API په کنسول کې پرانیزئ

تفصیلات

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

پارامترونه

نوم	ډول	اړین	دا څه شی دی
`targetId (path)`	`Uuid`	هو	The watched domain's id.

د غوښتنې بدن

نوم	ډول	اړین	دا څه شی دی
`domain`	`string`	هو	—
`label`	`string`	نه	—
`brand`	`string`	نه	—
`category`	`string`	نه	—
`market`	`string`	نه	—
`kinds`	`VisibilityAuditKind[]`	نه	—
`cadence_days`	`integer`	نه	—

ځواب

نوم	ډول	اړین	دا څه شی دی
`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}