visibility

PUT /v1/visibility/targets/{targetId}/review-profiles

Confirm which review profiles belong to this business.

จุดสิ้นสุด visibility ทั้งหมด

เอกสารสำหรับนักพัฒนาทั้งหมด

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

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

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

ทดลองใช้เลย

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

curl -X PUT https://api.zinndigital.com/v1/visibility/targets/{targetId}/review-profiles \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "profiles": <ReviewProfile[]> }'

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

รายละเอียด

A business is identified by a place_id at Google, a domain at Trustpilot and a url_path at Tripadvisor, and a search for a common trading name legitimately returns several records. The customer confirms which are theirs and the confirmed set is what the weekly reputation check refreshes. Nothing picks a profile automatically. Doing so would, for every chain and every shared trading name, report a stranger's reviews on a paying customer's dashboard.

พารามิเตอร์

ชื่อประเภทจำเป็นต้องมีลักษณะของสิ่งนี้
targetId (path)Uuidใช่The watched domain's id.

เนื้อหาคำขอ

ชื่อประเภทจำเป็นต้องมีลักษณะของสิ่งนี้
profilesReviewProfile[]ใช่

การตอบกลับ

ชื่อประเภทจำเป็นต้องมีลักษณะของสิ่งนี้
idUuidใช่UUIDv7 identifier — sortable by creation time (docs/02 §8).
domainstringใช่The hostname
labelstringไม่ใช่The customer's own label for this domain.
brandstringไม่ใช่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…
categorystringไม่ใช่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…
marketstringไม่ใช่Where the business sells. Used with category to build the questions.
is_externalbooleanใช่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_idstringไม่ใช่The site this target corresponds to, when it is one of ours.
kindsVisibilityAuditKind[]ใช่
cadence_daysintegerใช่Days between scheduled audits. 0 means paused — not deleted. History and settings survive and it resumes with no further action.
next_due_atstringไม่ใช่
last_audit_atstringไม่ใช่
review_profilesReviewProfile[]ไม่ใช่
profile_candidatesReviewProfile[]ไม่ใช่What the last lookupVisibilityReviewProfiles search found. Candidates only — the reputation check reads review_profiles, and a candidate becomes one when the customer confirms…
profile_lookupobjectไม่ใช่The last review-profile search's state. Empty when none was ever run.
productsTrackedProduct[]ไม่ใช่The products this organisation has asked us to price-track.
merchant_namesstring[]ไม่ใช่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,…
keywordsTrackedKeyword[]ไม่ใช่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