SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
seo

Read an audit with its findings and the pages that matter most.

pages ranks the audited pages by search traffic so fixes go where they count.

GEThttps://app.softsolz.uk/api/v1/services/seo/code/audits/{audit_id}

Recent Requests

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

Path Params

audit_idstringrequired

Headers

Authorizationstringrequired

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

Response

Response Body

auditobjectA code audit of a repository.
findingsarray of objectsFailed checks first, then passed.
pagesarray of objectsPages ordered by opportunity.

Request

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

Credentials

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

Response · 200

{
"data": {
"audit": {},
"findings": [],
"pages": []
}
}