SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester

List the monthly reports of one website, newest month first

GEThttps://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/runs

Recent Requests

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

Path Params

site_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

idstringReport (analysis run) id.
site_idstringWebsite the report belongs to.
period_startstringFirst day of the month analysed.
period_endstringLast day of the month analysed.
compare_period_startstringFirst day of the comparison month.
compare_period_endstringLast day of the comparison month.
statusstringWhere the report is.
detector_versionstringVersion of the detectors that produced the findings.
finding_countintegerHow many findings the detectors produced.
recommendation_countintegerHow many recommendations the report holds, including wins and API-added items.
action_countintegerRecommendations that need action: every recommendation except wins. Returned by the report lists.
credits_usednumberSoftSolz AI credits this report spent. Always 0 for API-started reports.
data_quality_jsonobjectData quality flags. narration = "skipped_for_api" means no explanations were written by SoftSolz, so write them through the narratives endpoints.
summary_markdownstring | nullShort summary of the report, Markdown.
error_messagestring | nullWhy the report failed, when it did.
task_idstring | nullBackground task id to poll while the report is running.
created_atstringWhen the report was started.
updated_atstringLast status change.

Request

curl --request GET \
--url https://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/runs \
--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",
"site_id": "3f2b9c44-8f4e-4d0a-9c1b-2a7d6e5f1a23",
"period_start": "2026-08-01",
"period_end": "2026-08-31",
"compare_period_start": "2026-07-01",
"compare_period_end": "2026-07-31",
"status": "queued",
"detector_version": "1.1.0",
"finding_count": 14,
"recommendation_count": 5,
"action_count": 4,
"credits_used": 0,
"data_quality_json": {
"enough_data": true,
"narration": "skipped_for_api"
},
"summary_markdown": "# Acme Bakery - 2026-08",
"error_message": null,
"task_id": null,
"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
}
}