List the audits of a repository, newest first.

GEThttps://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/code/repos/{repo_id}/audits

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

site_idstringrequired

repo_idstringrequired

Headers

Authorizationstringrequired

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

Query Params

limitinteger

Page size, 1 to 200 (default 50).

offsetinteger

Rows to skip before the first result.

Response

Response Body · array of objects

idstringAudit id. Use it as audit_id.

site_idstringWebsite audited.

repo_idstringRepository audited.

statusstringqueued, reading, auditing, completed or failed.

commit_shastring | nullCommit the audit read.

branchstring | nullBranch the audit read.

frameworkstring | nullFramework detected.

files_scannedintegerFiles read.

pages_scannedintegerPages checked.

passed_countintegerChecks that passed.

failed_countintegerChecks that failed.

scoreinteger | null0 to 100 health score.

summary_markdownstring | nullShort summary, Markdown.

error_messagestring | nullWhy the audit failed, when it did.

created_atstringWhen it was requested.

updated_atstringLast status change.

Request

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

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

const result = await client.seo.listSiteCodeRepoAudits('<site_id>', '<repo_id>', {});
console.log(result);

Credentials

Authorization

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

Response · 200

{
  "data": [
    {
      "id": "string",
      "site_id": "string",
      "repo_id": "string",
      "status": "string",
      "commit_sha": "string",
      "branch": "string",
      "framework": "string",
      "files_scanned": 0,
      "pages_scanned": 0,
      "passed_count": 0,
      "failed_count": 0,
      "score": 0,
      "summary_markdown": "string",
      "error_message": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}