SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
seo

Read a report in full: run, site, findings and recommendations.

Read this before writing narratives or recommendations. Every finding carries evidence_json with the numbers; findings with narrative null still need an explanation.

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

Recent Requests

Log in to see full request history
TimeStatusUser Agent
Make a request to see history.

Path Params

run_idstringrequired

Headers

Authorizationstringrequired

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

Response

Response Body

runobjectA monthly report.
siteobjectA tracked website.
findingsarray of objectsFindings ordered by impact, highest first.
recommendationsarray of objectsRecommendations ordered by priority rank.

Request

import { SoftSolz } from '@softsolz/sdk';
const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });
const result = await client.seo.getRun('<run_id>');
console.log(result);

Credentials

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

Response · 200

{
"data": {
"run": {},
"site": {},
"findings": [],
"recommendations": []
}
}