List the findings of an audit.

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

Recent Requests

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.

Query Params

statusstring

pass or fail.

limitinteger

Page size, 1 to 200 (default 50).

offsetinteger

Rows to skip before the first result.

Response

Response Body · array of objects

idstringCode finding id. Use it as finding_id under the audit.

check_idstringWhich check: title_present, title_length, description_present, description_length, viewport, lang, canonical, open_graph, structured_data, organization_schema, robots_txt, sitemap, llms_txt, security_txt and others.

categorystringGrouping of the check.

severitystringhigh, medium or low.

statusstringpass or fail.

scopestringsite for repository-wide checks, page for one file.

file_pathstring | nullRepository path of the page, when page-scoped.

page_pathstring | nullURL path the file renders.

titlestringWhat the check looks for.

detailstring | nullWhat was found.

fix_markdownstring | nullGeneric fix guidance, Markdown.

narrativestring | nullPlain-English explanation written for this repository.

narrative_sourcestring | nullsoftsolz or api.

narrative_authorstring | nullName of the app or key that wrote it.

evidence_jsonobjectFacts behind the finding.

Request

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

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

const result = await client.seo.listCodeAuditFindings('<audit_id>', {});
console.log(result);

Credentials

Authorization

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

Response · 200

{
  "data": [
    {
      "id": "string",
      "check_id": "string",
      "category": "string",
      "severity": "string",
      "status": "string",
      "scope": "string",
      "file_path": "string",
      "page_path": "string",
      "title": "string",
      "detail": "string",
      "fix_markdown": "string",
      "narrative": "string",
      "narrative_source": "string",
      "narrative_author": "string",
      "evidence_json": {}
    }
  ]
}