visibility
PUT /v1/visibility/targets/{targetId}/keywords
Set the search phrases to track positions for.
Authenticatie
Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.
Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X PUT https://api.zinndigital.com/v1/visibility/targets/{targetId}/keywords \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
Replaces the phrase list wholesale. The phrases are customer-supplied and never derived: only the customer knows which searches they want to win, and the ones they already rank for are precisely the set this product has nothing to say about. Each phrase carries its own market. The same phrase in two countries is two different questions with two different answers and two separate costs, so `{phrase: "hosting", location: "United Kingdom"}` and `{phrase: "hosting", location: "Germany"}` are two entries rather than one. Sending more phrases than the plan allows is refused with `422` naming the allowance. It is **not** truncated: silently checking the first twenty-five of two hundred reads as a complete list on the very screen the customer checks, and they would conclude the other one hundred and seventy-five were being watched.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
targetId (path) | Uuid | Ja | The watched domain's id. |
Aanvraaglichaam
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
keywords | TrackedKeyword[] | Nee | — |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
domain | string | Ja | The hostname |
label | string | Nee | The customer's own label for this domain. |
brand | string | Nee | 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 | Nee | 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 | Nee | Where the business sells. Used with `category` to build the questions. |
is_external | boolean | Ja | 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 | Nee | The site this target corresponds to, when it is one of ours. |
kinds | VisibilityAuditKind[] | Ja | — |
cadence_days | integer | Ja | Days between scheduled audits. `0` means paused — **not** deleted. History and settings survive and it resumes with no further action. |
next_due_at | string | Nee | — |
last_audit_at | string | Nee | — |
review_profiles | ReviewProfile[] | Nee | — |
products | TrackedProduct[] | Nee | The products this organisation has asked us to price-track. |
merchant_names | string[] | Nee | 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[] | Nee | 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… |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404 · 422