Recommendations
Get a recommendation
Read one Action Center recommendation by id: its steps, its column, and what its measurement found once done.
/v1/brands/{brand_id}/recommendations/{recommendation_id}One Action Center recommendation.
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.
recommendation_idstringrequiredThe recommendation id, from GET /v1/brands/{brand_id}/recommendations.
curl "https://api.ranqo.ai/v1/brands/BRAND_ID/recommendations/RECOMMENDATION_ID" \
-H "Authorization: Bearer $RANQO_API_KEY"Sample data from an invented brand. Try it shows your own.
Response
An Action Center recommendation.
idstringtitlestringdescriptionstringrationalestringcategorystringWhat kind of gap it answers, such as
content_gaporcitation_opportunity.action_typestring or nullcreate_content,optimize_page,fix_technical,build_authorityoroutreach; null on older ones.prioritystring or nullOne of
quick_win,strategic,moderate.impactinteger1-3, low to high.
effortinteger1-3, low to high.
statusstringThe Action Center column it sits in.
doneincludes one an Outreach target marked done moved there. One ofsuggested,in_progress,done,dismissed.stepsarray of objectsShow 2 fields insideHide the fields inside
textstringcompletedboolean
expected_outcomestring or nullrelated_domainsarray of stringsrelated_competitorsarray of stringsrelated_pagesarray of stringscreated_atstringRFC 3339 timestamp in UTC.
started_atstring or nullRFC 3339 timestamp in UTC. When it first moved to in progress.
done_atstring or nullRFC 3339 timestamp in UTC. When it last moved to done; null unless done.
measurementobject or nullNull unless it is done.
Show 11 fields insideHide the fields inside
statestringawaiting: its window is open and nothing is measured yet.measured: re-measured at least once.unmeasurable: no baseline was recorded, or it was done before measurement windows existed, so the board shows no countdown. One ofawaiting,measured,unmeasurable.expects_visibility_liftbooleanFalse for technical fixes, which are not expected to move visibility.
metricobject or nullWhat it is measured against:
overall,category:<category>orplatform:<engine>.Show 2 fields insideHide the fields inside
keystringlabelstring or null
baselinenumber or nullThe metric, 0-100, from the run it was generated from.
currentnumber or nullThe metric at the latest re-measure.
liftnumber or nullcurrentminusbaseline, in points, only when it is larger thannoise_bandeither way, as the Action Center shows it; null otherwise.noise_bandnumberPoints a quiet week moves this metric, measured over real runs.
measured_atstring or nullRFC 3339 timestamp in UTC.
window_opened_atstring or nullRFC 3339 timestamp in UTC. When its measurement window opened: the first time it moved to done or in review. Null when none opened.
runs_in_windowinteger or nullCompleted runs since its window opened, counted over the brand's latest 60 as the board counts them. Null when no window opened.
answersobject or nullThe answers inside the metric, compared with generation as of
measured_at; null until it is re-measured after a run in its window, and on older ones recorded without a per-answer baseline.Show 6 fields insideHide the fields inside
wonintegerAnswers missing the brand at generation that named it in both runs compared.
provisionalintegerAnswers missing it at generation that named it in the latest run compared only.
lostintegerAnswers that named it at generation and missed it in both runs compared.
heldintegerAnswers that named it at generation and still do.
runs_comparedintegerRuns after its window opened that the last re-measure compared, at most two.
confirmablebooleanTrue once two runs were compared. Until then
wonandlostare 0 and every gain is provisional.
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.