List monthly reports across every website, newest first.

GEThttps://app.softsolz.uk/api/v1/services/seo/runs

Recent Requests

TimeStatusUser Agent

Make a request to see history.

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.

site_namestringWebsite name.

site_domainstringWebsite domain.

period_startstringFirst day of the month analysed.

statusstringWhere the report is.

finding_countintegerHow many findings the detectors produced.

recommendation_countintegerHow many recommendations the report holds.

error_messagestring | nullWhy the report failed, when it did.

created_atstringWhen the report was started.

Request

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

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

const result = await client.seo.listRuns({});
console.log(result);

Credentials

Authorization

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

Response · 200

{
  "data": [
    {
      "id": "string",
      "site_id": "string",
      "site_name": "string",
      "site_domain": "string",
      "period_start": "string",
      "status": "string",
      "finding_count": 0,
      "recommendation_count": 0,
      "error_message": "string",
      "created_at": "string"
    }
  ]
}