visibility

POST `/v1/visibility/local/businesses`

Follow a business on the map, by its website's domain.

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 POST https://api.zinndigital.com/v1/visibility/local/businesses \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "domain": <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

Creates the watched target for the business's website (or adds local rankings to a target already watching that domain). Refused with 422 once the plan's business allowance is used. A business is its OWN allowance: it never spends one of the competitor domains the visibility plan gives. Pick the business on the map next, with POST /v1/visibility/targets/{targetId}/local/find.

Request body

Name	Type	Required	What it is
`domain`	`string`	Yes	The business's website.
`label`	`string`	No	—

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 · 403 · 422

POST /v1/visibility/local/businesses