List opportunities

GET/v1/opportunities

Ranked gaps where the brand could be named or cited: content gaps, sites to get listed on, technical blocks and wrong facts, with an estimated gain.

Read-onlyAll plans

Query parameters

brand_idstringoptionalThe brand to read. Optional when your key covers one brand; required for agency keys and when trying the API signed in.

statusenumoptionalDefault open.openin_progressdonedismissed

limitintegeroptionalHow many items to return, 1 to 100. Default 20.

A list of opportunity objects, largest estimated gain first.

objectstringAlways list.

dataarray of objectsThe items.

idstringOpportunity id, opp_….

typestringcontent, citation, technical or fact.

subjectstringThe topic, competitor, domain or fact it’s about.

impactstringhigh, medium or low.

gainnumber or nullEstimated visibility points.

effort_minutesintegerRough effort.

statusstringIts status.

has_morebooleanWhether there is another page.

next_cursorstring or nullPass as cursor to get the next page.

401unauthorizedMissing or revoked API key.

404not_foundNo brand with that id that this key can read.

429rate_limitedToo many requests; see Retry-After.