v1Resources/Social Listening/getList opportunities

List opportunities

Lists content and campaign opportunities found in a client's conversation, with their evidence. By default it returns new, saved and in-progress ones.

get/api/v1/listening/opportunities
listening:read
Query parameters
clientIdstringrequired
The client (business) this concerns. Required.
statusstringoptional
A comma-separated list of statuses: new, saved, in_progress, done, dismissed.
kindstring (content | campaign)optional
Only content or only campaign opportunities.
limitintegeroptional
How many to return, 1 to 50.
cursorstringoptional
The nextCursor from the previous page.
Response
dataobjectoptional
itemsarray of objectoptional
The opportunities.
totalintegeroptional
How many match.
nextCursorstringoptional
Pass this as cursor for the next page, or null at the end.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/listening/opportunities
Your API key
clientId *
status
kind
limit
cursor
{}

New to the Synup API?