visibility

PATCH /v1/visibility/targets/{targetId}

Change a watched domain's settings.

Tüm visibility uç noktaları

Kimlik Doğrulama

Bir API anahtarını bearer token olarak gönderin. Bu uç nokta, teknik özelliklerde belirli bir yetki belirtmemektedir; bu nedenle, varsaymak yerine anahtarınıza ihtiyaç duyduğu en az yetkiyi verin ve yanıtı kontrol edin.

Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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

Parametreler

AdTürZorunluNe olduğu
targetId (path)UuidEvetThe watched domain's id.

İstek gövdesi

AdTürZorunluNe olduğu
domainstringEvet
labelstringHayır
brandstringHayır
categorystringHayır
marketstringHayır
kindsVisibilityAuditKind[]Hayır
cadence_daysintegerHayır

Yanıt

AdTürZorunluNe olduğu
idUuidEvetUUIDv7 identifier — sortable by creation time (docs/02 §8).
domainstringEvetThe hostname
labelstringHayırThe customer's own label for this domain.
brandstringHayırThe 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…
categorystringHayırWhat 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…
marketstringHayırWhere the business sells. Used with `category` to build the questions.
is_externalbooleanEvetTrue when this is not a domain hosted with us — a competitor or a prospect. Only external targets count against the plan's allowance.
site_idstringHayırThe site this target corresponds to, when it is one of ours.
kindsVisibilityAuditKind[]Evet
cadence_daysintegerEvetDays between scheduled audits. `0` means paused — **not** deleted. History and settings survive and it resumes with no further action.
next_due_atstringHayır
last_audit_atstringHayır
review_profilesReviewProfile[]Hayır
productsTrackedProduct[]HayırThe products this organisation has asked us to price-track.
merchant_namesstring[]HayırHow 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…
keywordsTrackedKeyword[]HayırThe 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 uç noktanın dönderebileceği hatalar

401 · 403 · 404 · 422