SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester

List the recommendations of a report

GEThttps://app.softsolz.uk/api/v1/services/seo/runs/{run_id}/recommendations

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Path Params

run_idstringrequired

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Query Params

limitinteger

Page size, 1 to 200 (default 50).

offsetinteger

Rows to skip before the first result.

Response

Response Body · array of objects

idstringRecommendation id.
run_idstringReport the recommendation belongs to.
playstringWhich playbook produced it. external_suggestion for recommendations written through the API.
titlestringOne-line action.
detail_markdownstring | nullWhy and how, in Markdown.
priority_rankinteger | null1 is the most valuable recommendation in the report.
priority_scorenumberScore the rank was derived from.
estimated_effortstringRough effort.
opportunity_clicksnumberMonthly clicks the recommendation is worth: clicks still to win for a fix, or clicks already gained or lost for a movement.
statusstringDecision state.
dismissed_reasonstring | nullWhy it was dismissed, when it was.
task_idstring | nullTask created from it, when one was.
finding_idsarray of stringsFindings the recommendation is built on.
sourcestringdetector when SoftSolz produced it, api when a connected app did.
author_labelstring | nullName of the app or key that wrote it.
created_atstringCreation time.
updated_atstringLast change.

Request

curl --request GET \
--url https://app.softsolz.uk/api/v1/services/seo/runs/{run_id}/recommendations \
--header 'Authorization: Bearer sk_live_your_key'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
"data": [
{
"id": "3f2b9c44-8f4e-4d0a-9c1b-2a7d6e5f1a23",
"run_id": "3f2b9c44-8f4e-4d0a-9c1b-2a7d6e5f1a23",
"play": "external_suggestion",
"title": "Refresh the sourdough guide and add a starter recipe",
"detail_markdown": null,
"priority_rank": 3,
"priority_score": 180,
"estimated_effort": "low",
"opportunity_clicks": 180,
"status": "proposed",
"dismissed_reason": null,
"task_id": null,
"finding_ids": [
"3f2b9c44-8f4e-4d0a-9c1b-2a7d6e5f1a23"
],
"source": "api",
"author_label": "Claude",
"created_at": "2026-09-01T09:00:00.000Z",
"updated_at": "2026-09-01T09:00:00.000Z"
}
],
"meta": {
"limit": 50,
"offset": 0,
"total": 1,
"has_more": false
}
}