visibility
GET /v1/visibility/targets/{targetId}/local
One business's local set-up, every row's positions and their trend.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
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 GET https://api.zinndigital.com/v1/visibility/targets/{targetId}/local \
-H "Authorization: Bearer zdk_live_…"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
A row is one keyword searched from one town. Each carries its latest reading — the map position (of up to 100 listings read), the local 3-pack position on the results page and the website's organic position — the change since the previous reading, the businesses above it on the map, and up to twelve readings of trend. null positions mean "we looked and the business was not there", never zero; a row with latest: null has not been checked yet, and pending: true means its answer has been paid for and is on its way.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
targetId (path) | Uuid | Yes | The watched domain's id. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
target_id | string | Yes | — |
domain | string | Yes | — |
label | string | Yes | — |
business | LocalBusiness | null | Yes | — |
places | LocalPlace[] | Yes | — |
keywords | LocalKeyword[] | Yes | — |
rows | LocalRow[] | Yes | — |
last_checked_at | object | Yes | — |
Errors this endpoint can return
401 · 404 · 422