Share links

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

GET/sites/{site}/share-linksActive share links of the site (tokens are never returned)

Needs the reports.export permission in the account.

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

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

Link to this endpoint

POST/sites/{site}/share-linksCreate a read-only share link to the accessibility report or a dossier: kind acr|dossier, ref_id, days 1-90

Needs a token with api:write. Needs the reports.export 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}/share-links

Link to this endpoint

DELETE/sites/{site}/share-links/{id}Revoke a share link

Needs a token with api:write. Needs the reports.export permission in the account.

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

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

Link to this endpoint