Audits

Base URL: https://webvyze.com/api/v1 · click an endpoint for its scope, parameters, example and responses.

GET/audits/{audit}One audit with scores

Needs access to the site, when there is one.

Scope: api:read
Path parameters: {audit} integer
Responses: 200401402403422429

curl -H "Authorization: Bearer $WEBVYZE_KEY" \
  https://webvyze.com/api/v1/audits/{audit}

Link to this endpoint

GET/audits/{audit}/pagesPages crawled in an audit

Needs access to the site, when there is one.

Scope: api:read
Path parameters: {audit} integer
Responses: 200401402403422429

curl -H "Authorization: Bearer $WEBVYZE_KEY" \
  https://webvyze.com/api/v1/audits/{audit}/pages

Link to this endpoint

GET/sites/{site}/auditsAudits of a site

Needs access to the site, when there is one.

Scope: api:read
Path parameters: {site} integer
Responses: 200401402403422429

curl -H "Authorization: Bearer $WEBVYZE_KEY" \
  https://webvyze.com/api/v1/sites/{site}/audits

Link to this endpoint

POST/sites/{site}/auditsStart an audit (spends credits)

Needs a token with api:write. Needs the audits.run permission in the account.

Scope: api:write
Path parameters: {site} integer
Responses: 200401402403422429

curl -X POST -H "Authorization: Bearer $WEBVYZE_KEY" \
  -H "Content-Type: application/json" -d '{}' \
  https://webvyze.com/api/v1/sites/{site}/audits

Link to this endpoint