Outreach
List outreach targets
List a brand's Outreach targets in the board's rank order: the subreddits, threads and pages AI answers cite.
/v1/brands/{brand_id}/outreach-targetsThe brand's Outreach targets, ranked by opportunity score as the board ranks them. A board refresh re-scores them, so a cursor from before a refresh is refused: start again.
Authorization
AuthorizationstringheaderrequiredYour API key as Bearer ranqo_sk_…. The account owner creates keys in Settings, under API keys. See Authentication.
Path parameters
brand_idstringrequiredThe brand id, from GET /v1/brands.
Query parameters
Every parameter is optional. A parameter the endpoint does not take is refused with unknown_parameter.
limitintegerdefault: 50Items per page, 1 to 100.
Range: 1 ≤ x ≤ 100
cursorstringThe next_cursor of the previous page.
channelstringOptions:redditpublication
playstringOptions:commentpostpitch
statusstringOptions:suggestedin_progressdonedismissed
curl "https://api.ranqo.ai/v1/brands/BRAND_ID/outreach-targets" \
-H "Authorization: Bearer $RANQO_API_KEY"Sample data from an invented brand. Try it shows your own.
Response
The response body, as JSON.
dataarray of objectsShow 29 fields insideHide the fields inside
idstringchannelstringOne of
reddit,publication.kindstringA subreddit, one of its threads, or a published page. One of
community,thread,page.playstringcommentin a thread AI cites,postin a community,pitcha publication. One ofcomment,post,pitch.urlstringdomainstringsubredditstring or nulltitlestring or nullarticle_typestring or nullThe page's format, such as
ranked_listorcomparison.source_typestring or nullWho runs a publication, such as
editorialorreview: classed from the stored domain type and your competitors, as the Outreach board classes it (the Sources page can class a domain differently). Null for Reddit.citationsintegerTimes AI answers cited it over the 90 days before
counts_as_of. The counts, score andlast_cited_atbelow share that window.counts_as_ofstringThe refresh the counts are from: the board's latest, or for a target you started, finished or drafted that no longer appears, the last refresh that found it cited.
answersintegerAnswers that cited it.
promptsintegerPrompts whose answers cited it.
platformsarray of stringsEngines that cited it.
answers_naming_competitors_not_youintegerAnswers that cited it and named a rival but not you.
answers_naming_no_brandintegerAnswers that cited it and named no brand.
answers_naming_youintegerAnswers that cited it and named you.
competitors_namedarray of objectsUp to five rivals named in the answers that cited it without naming you, most first.
Show 2 fields insideHide the fields inside
namestringanswersinteger
opportunity_scorenumber0-100, how the board ranks it: how often AI cites it, the answers there that miss you, how many engines and prompts cite it, and how recently; for a publication also its format.
tierstringThe board's label for the score.
statusstringOne of
suggested,in_progress,done,dismissed.stepsarray of objectsShow 2 fields insideHide the fields inside
textstringcompletedboolean
rules_urlstring or nullThe subreddit's rules page.
last_cited_atstring or nullRFC 3339 timestamp in UTC. The latest answer in the window that cited it.
started_atstring or nullRFC 3339 timestamp in UTC.
completed_atstring or nullRFC 3339 timestamp in UTC.
recommendation_idstring or nullThe Action Center recommendation this work counts toward; marking the target done moves it to done.
cooling_sincestring or nullRFC 3339 timestamp in UTC. When you last finished a target in this subreddit, if within 14 days: pace yourself before posting there again. Null on a finished target.
has_morebooleanWhether another page follows.
next_cursorstring or nullPass as
cursorfor the next page; null on the last page.
Response headers
X-Request-IdThe request id; quote it to support.
RateLimitRequests left in this window and seconds until it resets.
RateLimit-PolicyThe key's limit per window.
Errors
Errors are problem details (application/problem+json) with a stable code. See Errors for each one.