List the monthly reports of one website, newest month first.

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

Recent Requests

TimeStatusUser Agent

Make a request to see history.

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.

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

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.seo.listSiteRuns('<site_id>', {});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": [
    {
      "id": "string",
      "site_id": "string",
      "period_start": "string",
      "period_end": "string",
      "compare_period_start": "string",
      "compare_period_end": "string",
      "status": "string",
      "detector_version": "string",
      "finding_count": 0,
      "recommendation_count": 0,
      "credits_used": 0,
      "data_quality_json": {},
      "summary_markdown": "string",
      "error_message": "string",
      "task_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}