visibility

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

Change a watched domain's settings.

การยืนยันตัวตน

ส่ง API key เป็น bearer token เอนด์พอยต์นี้ไม่ได้ระบุสิทธิ์การใช้งานเฉพาะในข้อกำหนด ดังนั้นควรให้คีย์ของคุณมีสิทธิ์น้อยที่สุดเท่าที่จำเป็นและให้ตรวจสอบจากการตอบกลับแทนที่จะคาดเดา

ปลายทางนี้ไม่ต้องใช้รหัสองค์กร คีย์ของคุณระบุองค์กรที่เป็นเจ้าของอยู่แล้ว และการตอบกลับจะถูกจำกัดขอบเขตไว้เฉพาะองค์กรนั้น

ทดลองใช้เลย

แทนที่สิ่งใดๆ ที่อยู่ภายในวงเล็บแหลมด้วยค่าของคุณเอง และตัวยึดตำแหน่งคีย์ด้วยคีย์จากแดชบอร์ดของคุณ

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.

พารามิเตอร์

ชื่อ	ประเภท	จำเป็นต้องมี	ลักษณะของสิ่งนี้
`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…
`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-visibility…
`market`	`string`	ไม่ใช่	Where the business sells. Used with `category` to build the questions.
`is_external`	`boolean`	ใช่	True when this is not one of this organisation's own domains — a competitor or a prospect. Only external targets count against the plan's allowance. A domain is the organisation's…
`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[]`	ไม่ใช่	—
`profile_candidates`	`ReviewProfile[]`	ไม่ใช่	What the last `lookupVisibilityReviewProfiles` search found. Candidates only — the reputation check reads `review_profiles`, and a candidate becomes one when the customer confirms…
`profile_lookup`	`object`	ไม่ใช่	The last review-profile search's state. Empty when none was ever run.
`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 listings,…
`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}