Start a monthly report with your own model doing the explaining
Queues the report: SoftSolz syncs Search Console, runs the detectors and builds recommendations, but writes no explanations, so no SoftSolz AI credits are spent. Poll GET /tasks/{task_id} until completed, then read GET /runs/{run_id} and write narratives with PUT /runs/{run_id}/narratives. 409 gsc_not_connected: connect Search Console in the dashboard. 409 run_exists: that month is already analysed, read it instead. 400 no_period_available: no complete month yet.
https://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/runsRecent Requests
Kept only in this browserPath Params
site_idstringrequiredHeaders
AuthorizationstringrequiredBearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.
Idempotency-KeystringOptional idempotency key for safe retries.
Body Params
period_startstringFirst day of the month to analyse. Defaults to the latest complete month.
Response
Response Body
runobjectA monthly report.task_idstringBackground task to poll.Request
curl --request POST \ --url https://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/runs \ --header 'Authorization: Bearer sk_live_your_key' \ --header 'Content-Type: application/json' \ --data '{ "period_start": "2026-08-01"}'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 · 202
{ "data": { "run": { "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" }, "task_id": "3f2b9c44-8f4e-4d0a-9c1b-2a7d6e5f1a23" }}