SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
seo

How the website has been doing, month by month.

Five pillars, weighted. A pillar with no data is left out and the score is re-weighted over what remains, so always read inputs_json before quoting a score: one built from five crawled pages is not the same as one built from five thousand. Search updates are returned as date bands and say only that something changed at Google then, never that it caused anything.

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

Recent Requests

Log in to see full request history
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.

Response

Response Body

monthsarray of objectsOldest first.
weightsobjectHow much each pillar counts.
search_updatesarray of objectsKnown Google updates in range.
notestringHow to read the score.
search_updates_notestringWhat the bands mean.

Request

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

Credentials

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

Response · 200

{
"data": {
"months": [],
"weights": {},
"search_updates": [],
"note": "string",
"search_updates_note": "string"
}
}