OpenAPI

OpenAPI validation

📄️Introduction

API for the APImetrics platform

📄️Accept invite secret

Accept an invite by link (invite_id + secret).

📄️Accept invite

Accept an org or project invite by urlsafe key (email must match caller).

📄️Account Settings

Account Settings

📄️Account

Account

📄️Add call to schedule

Add a target to an existing schedule.

📄️Get available agent location information

Return grouped agent metadata used to populate location pickers.

📄️Agents

Agents

📄️API Keys

API Keys

📄️API Monitor Statistics

API Monitor Statistics

📄️API Monitors

API Monitors

📄️Audits

Audits

📄️Auth Settings

Auth Settings

📄️Authenticate datadog integration

Authenticate datadog integration

📄️Baseline dailies

Baseline dailies

📄️Baseline hourlies

Baseline hourlies

📄️Browser Monitor Statistics

Browser Monitor Statistics

📄️Browser Monitors

Browser Monitors

📄️Parse a curl command and return a call definition

Parse a curl command into an (unsaved) API call representation.

📄️Calls

Calls

📄️Check undeliverable emails

Report which of the given addresses cannot be delivered to.

📄️Complete auth token wizard

Exchange the provider's authorization code for a stored auth token.

📄️Conditions

Conditions

📄️Conformance results summary

Query the latest conformance result summary for a project

📄️Conformance results

Query the conformance results

📄️Copy resources

Clone resources from the active project into another project.

📄️Create a new project

Create a new personal project owned by the caller.

📄️Create API key

Mint a new API key for the caller's project. The freshly generated secret

📄️Create a new API Monitor

Create a new API Monitor.

📄️Create an authentication configuration

Create an auth config for the project.

📄️Create auth token

Create an auth token bound to an auth setting.

📄️Create a new Browser Monitor

Create a new Browser Monitor

📄️Create call webhook v2

Create a webhook bound to a specific API call.

📄️Create an API call

Create a new API call.

📄️Create certificate

Create a new Certificate.

📄️Create or overwrite a variable (name in the body)

Create (or overwrite by name) a variable in a workspace.

📄️Create a workspace, or return the existing one

Create an environment workspace (idempotent-by-name).

📄️Upload a new file

Upload a file from the raw request body, storing it in GCS.

📄️Create hook

Create a hook bound to a workflow target.

📄️Create integration

Create integration

📄️Create a new MCP Monitor

Create a new MCP Monitor

📄️Create org downtime

Create a new downtime for this org.

📄️Create org invite

Create an invite for an account to join the organisation; sends an email.

📄️Create org role

Create a new role for an organization.

📄️Create project access

Grant an account direct access to a project.

📄️Create project in org

Create a new project in an organization.

📄️Create project invite

Create an invite for an account to join the project; sends an email.

📄️Create project role

Create a role on a project.

📄️Create a report

Create a new report.

📄️Create a downtime window for a schedule

Create a scheduled downtime under a schedule.

📄️Create schedule

Create a new schedule for the project.

📄️Create service account

Create a service account. The client_secret is returned once, here only.

📄️Create webhook v2

Create a project-level webhook.

📄️Create webhook

Create a new webhook for the project.

📄️Create a workflow

Create a new workflow.

📄️Crypto Utilities

Crypto Utilities

📄️Decode JWT

Decode a JWT (without verifying its signature).

📄️Delete account from org

Remove an account from an organization.

📄️Delete account setting variable

Remove the project's override for this variable.

📄️Delete API key

Delete an API key by its urlsafe id and echo the deleted key body.

📄️Delete an existing API Monitor

Delete an API Monitor.

📄️Delete an authentication configuration

Delete an auth config.

📄️Delete auth token

Delete an auth token, returning the deleted representation.

📄️Remove the script from a Browser Monitor

Clears the active Playwright script from this monitor.

📄️Delete an existing Browser Monitor

Delete an existing Browser Monitor

📄️Delete a call-level webhook

Delete a webhook bound to a specific API call, returning the deleted representation.

📄️Delete an API call

Delete an API call and return its last representation.

📄️Delete certificate

Delete an existing Certificate.

📄️Delete data check

Delete data check with the given name

📄️Delete a variable, if it exists

Delete a variable (idempotent).

📄️Delete an empty, unreferenced workspace

Delete an empty, unreferenced environment workspace.

📄️Delete a file

Delete a file (GCS blob is NOT deleted — preserving legacy behaviour).

📄️Delete hook

Delete a hook, returning the deleted representation.

📄️Delete integration

Delete integration

📄️Delete an existing MCP Monitor

Delete an existing MCP Monitor

📄️Delete org downtime

Delete an existing downtime for this org.

📄️Delete org invite

Delete a pending org invite. 404 if absent, 403 if org_id mismatch.

📄️Delete org role

Delete a role from an organization.

📄️Delete project access

Delete a project access grant.

📄️Delete project from org

Remove a project from an organization (re-homes it to community).

📄️Delete project invite

Delete a pending project invite. 404 if absent or from another project.

📄️Delete project role

Delete a project role.

📄️Delete project SLO

Delete the current project's SLO (idempotent).

📄️Delete a report

Delete a report and return its last representation.

📄️Delete a downtime window

Delete a scheduled downtime and return its last representation.

📄️Delete schedule

Delete an existing schedule for this org.

📄️Delete service account

Delete a service account and its Auth0 client and virtual user.

📄️Delete user

Remove a user from their org, clearing admin flag and access on owned models.

📄️Delete webhook v2

Delete a project-level webhook, returning the deleted representation.

📄️Delete webhook

Delete an existing webhook for this project.

📄️Delete a workflow

Delete a workflow and return its last representation.

📄️Email Subscriptions

Email Subscriptions

📄️Encode JWT

Sign a JWT from the supplied claims, headers and key.

📄️Ensure schedule call

Associate an API call with a schedule (idempotent; 202 if already associated).

📄️Ensure schedule workflow

Associate a workflow with a schedule (idempotent; 202 if already associated).

📄️Environment

Environment

📄️Evaluate most recent

Run conformance checks and summary calculation on the most recent calls

📄️Export project

Export the caller's project configuration as an import bundle.

📄️Export

Export

📄️Files

Files

📄️Get billing information for the account

Billing summary for every org/project the caller can bill for.

📄️Get account in org

Get an Auth0 account that is a member of the organization.

📄️Get quota information for the account

Quota and current usage for the caller's active project.

📄️Get account setting catalog

List every variable in the named catalog for the active project.

📄️Get account setting variable

Read a single variable's static config plus its current value.

📄️Get the authenticated account details

Return the caller's Auth0 profile fields.

📄️Get an API Monitor by ID

Get an API Monitor by ID.

📄️Get an authentication configuration

Get a single auth config.

📄️Get auth token

Get a single auth token.

📄️List conditions attached to a specific call

Get the post-test conditions for an API call.

📄️Get call failures

Deprecated: use the breakdown endpoint instead.

📄️Get HTTP status code breakdown for a call

HTTP status-code breakdown for a single period.

📄️Get call insights

Latest insights report for a single monitor (empty object if none).

📄️Get call legacy passfail range

Pass/fail counts grouped by period (legacy synopsis endpoint).

📄️Get call legacy passfail

Pass/fail counts for a single period (legacy synopsis endpoint).

📄️Get call metrics

Quantile statistics for one or more metrics, grouped by domain.

📄️Get call passfail range

Pass/fail counts grouped by period over a range.

📄️Get overall pass/fail totals for a call

Overall pass/fail totals over the call's most recent hour range.

📄️Get pass/fail stats per location for a call

Pass/warning/failure counts for a single period.

📄️Get stats for a call before a given time

Performance buckets up to an end time.

📄️Get call stats locations

Per-location aggregate counts and latency quantiles for one call.

📄️Get stats for a call since a given time

Performance buckets from a start time forwards.

📄️Get call stats summary

Aggregate counts and latency quantiles for one call over a window.

📄️Get aggregated performance stats for a call

Aggregated performance stats for a single period.

📄️List variable names that this call's conditions write

List variable names set by a monitor's post-test conditions.

📄️List variable names referenced in the call definition

List variable names referenced by a monitor's request.

📄️Get a call-level webhook

Get a webhook bound to a specific API call.

📄️Get a single API call

Get a single API call by id.

📄️Get current project

Get the current project.

📄️Get endpoint classifications

Manage the classification of endpoints for a given spec

📄️Read a variable, or an empty object if absent

Get a single variable by name.

📄️Download the raw content of a file

Serve the raw GCS content of a file.

📄️Get file metadata

Return the metadata representation of a single file.

📄️Get hook

Get a hook.

📄️Get insights outliers

Download an outliers blob, rewriting numeric result ids to urlsafe keys.

📄️Get insights

Download a pre-computed insights report blob from cloud storage.

📄️Get integration by ID

Get integration by ID

📄️Read a Monitor by ID

Read a Monitor by ID

📄️Get notification

Return the representation of a single notification.

📄️Get subscription for an organisation

Get subscription for an organisation

📄️Get usage statistics for an organisation subscription

Get usage statistics for an organisation subscription

📄️Get an organisation

Get an organization by ID.

📄️Get organization synopsis

Get a rolled-up synopsis for every project the caller can see in an organization.

📄️Get project access

Get a project access grant by id.

📄️List conditions for the project

Get the project-default post-test conditions.

📄️Get project role

Get a project role by id.

📄️Get project SLO

Get the current project's SLO (defaults when none is stored).

📄️Get subscription for a project

Get subscription for a project

📄️Get project suppliers

Return the list of enabled suppliers for the selected project.

📄️Get project synopsis

Get the pre-aggregated synopsis for the current project.

📄️Get usage statistics for a project subscription

Get usage statistics for a project subscription

📄️Get project

Get a project by key.

📄️Get public report insights

Latest CASC insights report for one call of a public report.

📄️Get public report stats

Rolling-window status counts for one call of a public report.

📄️Get public report

Read a public report without authentication.

📄️Get report CSV

Download per-call pass/warn/fail counts and latency stats as CSV.

📄️Get report group CSV

Download one report group's per-call stats as CSV.

📄️Get report group locations CSV

Download one report group's stats broken down by agent location as CSV.

📄️Get report locations CSV

Download the report stats broken down by agent location as CSV.

📄️Get a report

Get a single report by id.

📄️Get result content

Download the raw response body for a result.

📄️Get result PCAP

PCAP download is not available in this environment.

📄️Get result screenshot

Get result screenshot

📄️Get result

Get a single result.

📄️Get a downtime window

Get a single scheduled downtime by id.

📄️Get schedule

Get a specific schedule by ID.

📄️Get service account

Get a single service account. The client_secret is never returned.

📄️Get suppliers results

Query the current supplier results for the selected project

📄️Get user by username

Get a user by username. Full details for site/org admins; username only otherwise.

📄️Get user

Get a user by NDB key. Full details for site/org admins; username only otherwise.

📄️Get parameter schema for a webhook type

List the parameter descriptors for a webhook service type.

📄️Get webhook v2

Get a project-level webhook.

📄️Get webhook

Get a specific webhook by ID.

📄️Get workflow locations

Get workflow locations

📄️Get workflow result

Get a single workflow result.

📄️Get a workflow

Get a single workflow by id.

📄️Grant service account project access

Grant a service account a project access level (VIEWER/EDITOR/etc.).

📄️HMAC hash

Compute an HMAC digest of a message under a key and hash algorithm.

📄️Hooks

Hooks

📄️Import project

Import a configuration bundle into the caller's project.

📄️Import sample projects

Clone one or more sample-org projects into the caller's project.

📄️Import

Import

📄️Ingest external source

Ingest external source

📄️Insights

Insights

📄️Invites

Invites

📄️List all projects accessible to the account

List the projects and organizations the caller can access.

📄️List account setting catalogs

List every enabled settings catalog available on the platform.

📄️List accounts in org

List Auth0 accounts in an organization. Org admins (and site admin/analyst/viewer) get full account details; other org members get a reduced set of display-only fields.

📄️List accounts subscribed at level

List every account subscribed to this project's digests at the given level.

📄️List accounts subscribed

List every account subscribed to this project's email digests.

📄️List agents for project

List all agents accessible to a project.

📄️List API keys

List every API key bound to the caller's project (including the caller's

📄️List API Monitors for a project

List API Monitors for the project, ordered by name.

📄️List audit log entries for an organisation

List audit records for an organization.

📄️List audit log entries for a specific resource

List audit records for a specific resource, optionally merging related kinds.

📄️List audit log entries for the project

List audit records for the project.

📄️List auth configs for a specific domain

List auth configs for the project filtered by domain.

📄️List authentication configurations

List auth configs for the project.

📄️List auth tokens by auth setting

List auth tokens belonging to a single auth setting.

📄️List auth tokens

List auth tokens for the project, ordered by name.

📄️List all Browser Monitors for a project

List all Browser Monitors for a project

📄️List webhooks attached to a call

List webhooks bound to a specific API call.

📄️List calls that use a specific auth config

List API calls that use a given auth (ServiceConfig).

📄️List API calls

List API calls for the authenticated project.

📄️List certificates

List metadata for all of an org's Certificates.

📄️List changes

Return a list of changes within the given time range.

📄️List data checks

List data checks for the given project

📄️List email subscriptions

List every unsubscribe group and whether the caller is suppressed in it.

📄️List the variables in a workspace

List variables in an environment workspace.

📄️List environment workspaces

List environment workspaces for the authenticated project.

📄️List uploaded files

List file uploads for the project, ordered by filename ascending.

📄️List hooks

List hooks for the project, newest first.

📄️List insights rank history

good/ok/bad score-band counts per period bucket across a date window.

📄️List insights rank

Score-ranked most-recent reports plus a short score history per monitor.

📄️List insights

List pre-computed insights reports for the project.

📄️List integrations for org

List integrations for org

📄️List inventory

Return a list of discovered endpoints.

📄️List all MCP Monitors for a project

List all MCP Monitors for a project

📄️List all Monitors for a project

List all Monitors for a project

📄️List notifications for a specific call

List notifications referencing a specific call, newest first.

📄️List notification log entries

List notifications owned by the project, newest first.

📄️List org downtimes

List downtimes defined on the given org.

📄️List org invites

List pending invites for the organisation, ordered by email.

📄️List org roles

List all roles defined for an organization.

📄️List organisations the account belongs to

List all organizations (site admin/analyst/viewer/quota_viewer only).

📄️List project access by org

List all direct account access grants across an organization's projects.

📄️List project access

List direct account access grants for a project.

📄️List project invites

List pending invites for the project, ordered by email.

📄️List project roles by org

List all project roles across an organization's projects.

📄️List project roles

List roles for a project.

📄️List projects in an organisation

List projects in an organization.

📄️List projects subscribed at level

List every project the caller is subscribed to at the given digest level.

📄️List projects subscribed

List every project the caller is subscribed to across all projects.

📄️List reports

List reports for the authenticated project.

📄️List execution results for an API call

List results for a specific API call (alias path).

📄️List results by call

List results for a specific API call.

📄️List results by hook alias

List results for a specific webhook (alias path).

📄️List results by hook

List results for a specific webhook.

📄️List results

List results for a project.

📄️List scheduled downtime windows for a schedule

List scheduled downtimes for a schedule.

📄️List schedules that include a specific call

List schedules that target a specific API call.

📄️List schedules that include a specific workflow

List schedules that target a specific workflow.

📄️List schedules

List schedules for the project.

📄️List security profiles for project

List security profiles for project

📄️List service accounts

List the service accounts defined on the given organization.

📄️List settings

Retrieve the conformance settings for a project

📄️List suppliers

Return a categorised list of suppliers.

📄️List available webhook integration types

List every supported webhook service type.

📄️List webhooks v2

List project-level webhooks.

📄️List webhooks

List webhooks for the project.

📄️List execution results for a workflow

List results for a workflow within the ``?from``/``?time`` date window.

📄️List workflows by call

List workflows that reference a specific API call.

📄️List workflows

List all workflows for the authenticated project.

📄️Logout

Clear the legacy session cookie. Always returns ``'OK'``.

📄️Manage endpoint classification

Manage the classification of endpoints for a given spec

📄️Manage

Manage

📄️MCP Monitor Statistics

MCP Monitor Statistics

📄️MCP Monitors

MCP Monitors

📄️Monitors

Monitors

📄️Move resources

Re-parent resources from the active project to another project.

📄️Notifications

Notifications

📄️OAS coverage

Return API call coverage data for OpenAPI endpoints.

📄️OAS endpoints

Return a list of endpoints for the requested OpenAPI spec.

📄️OpenAPI

OpenAPI

📄️Org billing quota

Org billing quota

📄️Org billing usage counts

Org billing usage counts

📄️Org slow calls daily CSV

Org slow calls daily CSV

📄️Org slow calls monthly

Org slow calls monthly

📄️Organization Roles

Organization Roles

📄️Organizations

Organizations

📄️Partially update an existing API Monitor

Update only the supplied fields of an API Monitor.

📄️Patch an existing MCP Monitor

Patch an existing MCP Monitor

📄️Project Access

Project Access

📄️Project billing quota

Project billing quota

📄️Project billing usage counts

Project billing usage counts

📄️Project calls monthly

Project calls monthly

📄️Project Roles

Project Roles

📄️Project Setup

Project Setup

📄️Project SLOs

Project SLOs

📄️Project Subscriptions

Project Subscriptions

📄️Project Synopsis

Project Synopsis

📄️Projects

Projects

📄️Update data check

Create or update data check with the given name

📄️Update project suppliers

Set the list of enabled suppliers for the selected project

📄️Update settings

Insert or update conformance settings for a project

📄️DNS diagnostics across all API monitors in the project

Aggregate DNS diagnostics across all API monitors in the project.

📄️DNS diagnostics for an API monitor over a window

Aggregate DNS diagnostics for an API monitor over a window.

📄️Aggregate performance metrics for an API monitor over a window

Aggregate performance metrics for an API monitor over a window.

📄️Aggregate performance metrics across all API monitors in the project

Aggregate performance metrics across all API monitors in the project.

📄️Aggregate performance metrics for a monitor over a window

Aggregate performance metrics for a monitor over a window.

📄️Aggregate resource-level data from `resource_requests` for a monitor

Aggregate resource-level data from `resource_requests` for a browser monitor.

📄️Query the top-N raw page_metrics rows sorted by the chosen metric

Return the top-N raw page_metrics rows sorted by the chosen metric.

📄️Aggregate performance metrics across all browser monitors in the project

Aggregate performance metrics across all browser monitors in the project.

📄️Aggregate resource-level data across all browser monitors in the project

Aggregate resource-level data from `resource_requests` across all

📄️Top-N raw page_metrics rows across all browser monitors in the project

Return the top-N raw page_metrics rows across all browser monitors in

📄️Aggregate performance metrics for an MCP monitor over a window

Aggregate performance metrics for an MCP monitor over a window.

📄️Aggregate performance metrics across all MCP monitors in the project

Aggregate performance metrics across all MCP monitors in the project.

📄️Read a Browser Monitor by ID

Read a Browser Monitor by ID

📄️Read certificate

Read an existing Certificate.

📄️Read an MCP Monitor by ID

Read an MCP Monitor by ID

📄️Reject invite

Delete (reject) an invite; email must match the caller's account.

📄️Remove call from schedule

Remove a target from an existing schedule.

📄️Remove schedule call

Disassociate an API call from a schedule (202 if it was not associated).

📄️Remove schedule workflow

Disassociate a workflow from a schedule (202 if it was not associated).

📄️Replace current project

Update the current project's name or tags (alias of POST).

📄️Replace file content

Replace the GCS content of an existing file.

📄️Reports

Reports

📄️Request a password reset

Send a password-reset email (own address, or another if authorised).

📄️Reset account setting catalog

Reset every variable in the catalog back to the platform default.

📄️Results

Results

📄️Revoke service account project access

Revoke a service account's access to a project.

📄️Rotate service account secret

Rotate the client secret. The new secret is returned once, here only.

📄️RSA sign

Produce an RSA signature of a message using a PEM private key.

📄️Trigger an immediate (on-demand) execution of an API call

Trigger an on-demand run of an API call.

📄️Trigger a Monitor to run now

Trigger a Monitor to run now

📄️Trigger an immediate execution of a workflow

Trigger an on-demand run of a workflow.

📄️Run workflow

Run workflow

📄️Schedules

Schedules

📄️Session

Session

📄️Set account setting variable

Override the variable's value for this project.

📄️Create a condition for a specific call

Replace the post-test conditions for an API call.

📄️Create a project-level condition

Replace the project-default post-test conditions.

📄️Snooze webhook v2

Snooze (partially update) a webhook.

📄️Start auth token wizard

Begin the OAuth token wizard for an auth setting.

📄️Stats

Stats

📄️Subscribe to email group

Subscribe the caller to a group, so its email reaches them again.

📄️Subscribe to project emails

Subscribe to email digests for the active project.

📄️Tag project entities

Assign ``importer:<slug>`` tags to any project entities that lack one.

📄️Tag project for openapi

Tag project for openapi

📄️Unsubscribe from email group

Unsubscribe the caller from a group, so its email no longer reaches them.

📄️Unsubscribe from project emails

Unsubscribe from all email digests for the active project.

📄️Update account

Update the caller's Auth0 profile via the Management API.

📄️Replace an existing API Monitor

Replace an API Monitor. Optional fields left out revert to defaults.

📄️Update an authentication configuration

Update an auth config.

📄️Update auth token

Partially update an auth token.

📄️Update an existing Browser Monitor

Update an existing Browser Monitor

📄️Update a call-level webhook

Partially update a webhook bound to a specific API call.

📄️Update call

Partially update an API call (only supplied fields change).

📄️Update certificate

Update an existing Certificate.

📄️Update current project

Update the current project's name or tags.

📄️Set a variable's value (name in the path)

Set a variable's value, creating the variable if it does not exist.

📄️Update a workspace's title

Update an environment workspace's title.

📄️Update file

Partial-merge update of file metadata.

📄️Update hook

Partially update a hook.

📄️Update integration

Update integration

📄️Update KMS helper

Create a new KMS helper API call based on an existing old helper API call.

📄️Update an existing MCP Monitor

Update an existing MCP Monitor

📄️Update notification

Update the ``viewed`` flag for the requesting project. No other field is writable.

📄️Update org downtime

Update an existing downtime for this org.

📄️Update subscription for an organisation

Update subscription for an organisation

📄️Update org

Update an organization's name, tags, or security settings.

📄️Update project access

Update a project access grant.

📄️Update project role

Update a project role.

📄️Update project SLO

Create or update the current project's SLO.

📄️Update subscription for a project

Update subscription for a project

📄️Update project

Update a project's name, tags, email, or security profile.

📄️Update report

Partially update a report (only supplied fields change; groups are replaced).

📄️Update resolution

Update the resolution status for a conformance result

📄️Update a downtime window

Partially update a scheduled downtime (only supplied fields change).

📄️Update schedule

Update an existing schedule.

📄️Update service account roles

Replace the organization roles granted to a service account.

📄️Update user

Update a user's admin flag. Requires org-admin or site-admin.

📄️Update webhook v2

Partially update a project-level webhook.

📄️Update webhook

Update an existing webhook.

📄️Update a workflow

Partially update a workflow (only supplied fields change).

📄️Upload a Playwright script and attach it to a Browser Monitor

Upload a Python Playwright script and set it as the active script for this monitor. To remove the script, use DELETE on this endpoint.

📄️Import a file from a URL

Download a remote URL and store the content as a file in GCS.

📄️Upload new OAS from URL

Upload a new OpenAPI spec.

📄️Upload new OAS

Upload a new OpenAPI spec.

📄️Users (admin)

Users (admin)

📄️Validate openapi

Validate openapi

📄️Verify the account email address

(Re)send the caller's email-verification message if not yet verified.

📄️Verify invite secret

Verify an invite link (invite_id + secret) and return the invite.

📄️Webhooks

Webhooks

📄️Workflows

Workflows