visibility
POST /v1/visibility/targets/{targetId}/review-profile-lookup
Search the review sites for this business.
Аутентификација
Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X POST https://api.zinndigital.com/v1/visibility/targets/{targetId}/review-profile-lookup \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
Starts a search of Google, Trustpilot and Tripadvisor for the business and returns 202 with the target, its profile_lookup.status now running. The candidates land in profile_candidates when the search finishes; poll the target. Nothing is confirmed automatically — confirm with setVisibilityReviewProfiles. Included in the reputation add-on, and refused with 403 for an organisation that does not hold it or is not in good standing. One search runs per target at a time.
Параметри
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
targetId (path) | Uuid | Да | The watched domain's id. |
Тело захтева
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
query | string | Не | The business name. Defaults to the target's brand, label or domain. |
location | string | Не | A town or country to narrow the search. Defaults to the target's market. |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
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… |
prompts | string[] | Не | The customer's own questions for the AI answer engines. Empty means the default questions built from category and market. Bounded by the prompts allowance. |
watched_links | WatchedLink[] | Не | The individual links the customer watches pointing at this domain. What each link was found to be is a reading on the latest link_watch audit, not here. Bounded by the links… |
mention_phrases | MentionPhraseState[] | Не | The phrases this organisation listens for on this domain (brand mentions), each with its own schedule as the checks actually left it. |
Грешке које ова крајња тачка може вратити
401 · 403 · 404 · 422 · 503