research-reports

Run site audit

Changed on

Access follows existing project membership and token scopes.

post/projects/{project_id}/site-audits

Request

  • Base URL: https://eu.bisibility.com/api/v1
  • URL: https://eu.bisibility.com/api/v1/projects/{project_id}/site-audits
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL /api/auth/oauth2/authorize, token URL /api/auth/oauth2/token, scopes: api:write)

Path parameters

project_idstring required
Example:prj_a00000000000000000000000

Headers

Bisibility-API-Version'v1'

API contract version requested by the client. Omit this header to use the current backward-compatible behavior.

Idempotency-Keystring

Optional key that makes a retry of this request return the first response instead of running it again. Replays last 24 hours and are scoped to the credential, method and path.

X-Bisibility-Source'sdk' | 'cli' | 'mcp'

Declares the client that produced the request for usage reporting: sdk, cli or mcp. Optional; any other value counts as api. It never changes authentication or which budget applies (every bearer-authenticated request counts against the API, MCP and SDK budget).

Request body

max_pagesinteger

Response

Project-scoped result

Example response

{
  "data": {
    "id": "agr_a00000000000000000000000"
  }
}

Changes

  • a6e1ec0dec82Revision changes
    • breaking

      response property data/result/pages/items/canonical list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property data/result/pages/items/description list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property data/result/pages/items/robots list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property data/result/pages/items/status list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property data/result/pages/items/title list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the // response's property type changed from no type to number for status

    • info

      the endpoint scheme security AppOAuth was added to the API

    • info

      added the new optional header request parameter Idempotency-Key

    • info

      the response property const value 15000 was added for the status

    • info

      the response property const value 524288 was added for the status

    • info

      the response property const value 20 was added for the status

    • info

      the / response's property pattern ^agr_[a-z][a-z0-9]{23}$ was added for the status

    • info

      the // response's property pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ was added for the status

    • info

      the // response's property pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ was added for the status