visibility
GET /v1/visibility/targets/{targetId}/mentions
The web pages that mention this domain's phrases, newest found first.
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}/mentions \
-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
Reads what the scheduled checks already found — it never calls the data provider, so paging through mentions costs nothing. 403 when brand mentions is not on the plan.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
targetId (path) | Uuid | Yes | The watched domain's id. |
phrase (query) | string | No | Only mentions of this phrase. |
tone (query) | string<positive, neutral, negative> | No | — |
limit (query) | integer | No | — |
offset (query) | integer | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
mentions | BrandMention[] | Yes | — |
total | integer | Yes | How many stored mentions match, of which mentions is one page. A page alone reads as complete; total is what lets a screen say "showing 50 of 312". |
limit | integer | Yes | — |
offset | integer | Yes | — |
Errors this endpoint can return
401 · 403 · 404