visibility
GET /v1/visibility/local
Local rankings — the allowances and every business followed.
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/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
What the Local Rankings plan allows (businesses, towns per business, keyword rows and checks a month, and the fastest schedule a keyword may run at) with what is used, and a summary row per business. A cap of null means unlimited. Readable by any member.
Response
| Name | Type | Required | What it is |
|---|---|---|---|
entitled | boolean | Yes | Whether the org holds Local Rankings. |
allowances | object | Yes | — |
businesses | LocalBusinessSummary[] | Yes | — |
Errors this endpoint can return
401 · 403