REST API Endpoints — Audits, Settings & Utilities

This is part of the REST API Endpoint Reference. For authentication, rate limits, and general API usage, see REST API – Getting Started.

Endpoint Reference Sub-Pages

UX Audits

Base path: /api/v1/websites/:websiteId/ux-audits

MethodPathDescriptionScope
GET/api/v1/websites/:websiteId/ux-auditsList UX audits for a websiteread:organization
POST/api/v1/websites/:websiteId/ux-auditsCreate a new AI-powered UX auditwrite:organization
GET/api/v1/websites/:websiteId/ux-audits/:auditIdGet UX audit detailsread:organization
GET/api/v1/websites/:websiteId/ux-audits/:auditId/reportGet UX audit report (202 if processing)read:organization

Reference Data

Base path: /api/v1

MethodPathDescriptionScope
GET/api/v1/plansList available pricing plansread:organization
GET/api/v1/rolesList available team member rolesread:organization

Settings

Base path: /api/v1/settings – Read-only (GET). Write endpoints (PUT) require admin role.

MethodPathDescriptionScope
GET/api/v1/settings/scheduleGet default test schedule settingsread:organization
GET/api/v1/settings/usageGet monthly test limitread:organization
GET/api/v1/settings/usage/reportsGet usage reports for a date rangeread:organization
GET/api/v1/settings/deviceGet default device typeread:organization
GET/api/v1/settings/pluginsGet plugin visibility settingsread:organization
GET/api/v1/settings/auto-retryGet auto-retry settingread:organization
GET/api/v1/settings/variablesGet test variablesread:organization

Test Flow Types

Base path: /api/v1/test-flow-types

MethodPathDescriptionScope
GET/api/v1/test-flow-typesGet available test flow typesread:organization

Related Articles

Docs