How to use this API well. Read it once before anything else.

Returns the call order for the whole loop, the exact scoring formula and its weights, the vocabularies (families, statuses, intents, indexing states, readiness components), the evidence rules that say what may and may not be claimed from this data, and the limits. Everything in it is read from the live code, so it never drifts from what the API actually enforces. Read it, then start with GET /sites.

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

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.

Response

Response Body

workflowarray of stringsThe call order, in sentences.

hard_rulesarray of stringsWhat may never be claimed from this data.

scoringobjectThe opportunity score formula, its weights and the click-through curve.

taxonomyobjectFamilies, statuses, intents, indexing states and readiness components.

evidence_rulesobjectWhat each kind of number does and does not prove.

limitsobjectThresholds, caps and request limits.

Request

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

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

const result = await client.seo.getGuide();
console.log(result);

Credentials

Authorization

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

Response · 200

{
  "data": {
    "workflow": [],
    "hard_rules": [],
    "scoring": {},
    "taxonomy": {},
    "evidence_rules": {},
    "limits": {}
  }
}