visibility
PUT /v1/visibility/targets/{targetId}/brand-serp
Set the brand searches whose first Google page is watched (the brand and up to four variants).
Authentication
Send an API key as a bearer token. The endpoint checks sites.create; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X PUT https://api.zinndigital.com/v1/visibility/targets/{targetId}/brand-serp \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "terms": <string[]> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Each search is one check per run at the per-check price, so the list is the bill the customer chooses. An empty list watches the brand name. 422 for more than five searches or one longer than 120 characters — refused, never truncated.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
targetId (path) | Uuid | Yes | The watched domain's id. |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
terms | string[] | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
enabled | boolean | Yes | Brand page 1 is switched on for this domain (it watches brand_serp and pays per check from Zinn® credits). Before it is, the page carries the quote and no results. |
terms | string[] | Yes | The searches each run checks (the brand, when none are set). |
custom_terms | string[] | Yes | — |
max_terms | integer | Yes | — |
quote | BrandSerpQuote | Yes | What brand page 1 costs, read from the live per-check Zinn® credit price row — the same product the run debits, so the quote is the charge. USD micros (a check is under two cents,… |
results | BrandSerpResult[] | Yes | — |
total | integer | Yes | — |
limit | integer | Yes | — |
offset | integer | Yes | — |
last_run | VisibilityAudit | No | — |
held | boolean | Yes | Checks are paused for want of Zinn® credit; a top-up resumes them. |
Errors this endpoint can return
401 · 403 · 404 · 422