Recommendations
Get a recommendation
Read one Action Center recommendation by id: its steps, its column, and what its measurement found once done.
HTTP
GET https://api.ranqo.ai/v1/brands/{brand_id}/recommendations/{recommendation_id}One Action Center recommendation.
Path parameters
| Name | Type | Description |
|---|---|---|
brand_id | string | The brand id, from GET /v1/brands. |
recommendation_id | string | The recommendation id, from GET /v1/brands/{brand_id}/recommendations. |
Response
An Action Center recommendation.
| Field | Type | Description |
|---|---|---|
id | string | |
title | string | |
description | string | |
rationale | string | |
category | string | What kind of gap it answers, such as content_gap or citation_opportunity. |
action_type | string or null | create_content, optimize_page, fix_technical, build_authority or outreach; null on older ones. |
priority | string or null | One of quick_win, strategic, moderate. |
impact | integer | 1-3, low to high. |
effort | integer | 1-3, low to high. |
status | string | The Action Center column it sits in. done includes one an Outreach target marked done moved there. One of suggested, in_progress, done, dismissed. |
steps | array of objects | |
steps[].text | string | |
steps[].completed | boolean | |
expected_outcome | string or null | |
related_domains | array of strings | |
related_competitors | array of strings | |
related_pages | array of strings | |
created_at | string | RFC 3339 timestamp in UTC. |
started_at | string or null | RFC 3339 timestamp in UTC. When it first moved to in progress. |
done_at | string or null | RFC 3339 timestamp in UTC. When it last moved to done; null unless done. |
measurement | object or null | Null unless it is done. |
measurement.state | string | awaiting: 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 of awaiting, measured, unmeasurable. |
measurement.expects_visibility_lift | boolean | False for technical fixes, which are not expected to move visibility. |
measurement.metric | object or null | What it is measured against: overall, category:<category> or platform:<engine>. |
measurement.metric.key | string | |
measurement.metric.label | string or null | |
measurement.baseline | number or null | The metric, 0-100, from the run it was generated from. |
measurement.current | number or null | The metric at the latest re-measure. |
measurement.lift | number or null | current minus baseline, in points, only when it is larger than noise_band either way, as the Action Center shows it; null otherwise. |
measurement.noise_band | number | Points a quiet week moves this metric, measured over real runs. |
measurement.measured_at | string or null | RFC 3339 timestamp in UTC. |
measurement.window_opened_at | string or null | RFC 3339 timestamp in UTC. When its measurement window opened: the first time it moved to done or in review. Null when none opened. |
measurement.runs_in_window | integer or null | Completed runs since its window opened, counted over the brand's latest 60 as the board counts them. Null when no window opened. |
measurement.answers | object or null | The 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. |
measurement.answers.won | integer | Answers missing the brand at generation that named it in both runs compared. |
measurement.answers.provisional | integer | Answers missing it at generation that named it in the latest run compared only. |
measurement.answers.lost | integer | Answers that named it at generation and missed it in both runs compared. |
measurement.answers.held | integer | Answers that named it at generation and still do. |
measurement.answers.runs_compared | integer | Runs after its window opened that the last re-measure compared, at most two. |
measurement.answers.confirmable | boolean | True once two runs were compared. Until then won and lost are 0 and every gain is provisional. |
Response headers
| Header | Description |
|---|---|
X-Request-Id | The request id; quote it to support. |
RateLimit | Requests left in this window and seconds until it resets. |
RateLimit-Policy | The key's limit per window. |
Example request
curl
curl "https://api.ranqo.ai/v1/brands/BRAND_ID/recommendations/RECOMMENDATION_ID" \
-H "Authorization: Bearer $RANQO_API_KEY"Errors
Errors are problem details (application/problem+json) with a stable code. See Errors for each one.