APIContext Platform API
The full APIContext (APImetrics) platform API — 325 operations across 217 paths, described by a first-party OpenAPI 3.1.0 document (info.version v2026-09-02) published at https://client.apimetrics.io/openapi.json. Two major versions are served side by side from one host: /api/2 (144 paths) and /api/3 (73 paths). Covers monitors, schedules, workflows, results, statistics, insights, conformance governance, webhooks, projects, organizations, billing quota and service accounts.
APIContext Platform API is one of 16 APIs that APIContext publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include API Monitoring, Conformance, Performance, Platform, and SLO. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 325 operations across 217 paths, organized into 55 resource areas, and defines 560 schemas. It is described by OpenAPI 3.1.0, at version v2026-09-02.
Requests are made against a single base URL, https://client.apimetrics.io.
325 operations
217 paths
560 schemas
42 DELETE161 GET1 PATCH99 POST22 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
APIContext Platform API declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 3 scopes.
An API key is passed in the header as X-Api-Key (ApiKey).
Paths & Operations 325
Across 217 paths, the API surfaces 325 operations — 42 DELETE, 161 GET, 1 PATCH, 99 POST, 22 PUT. They span 55 resource areas, including Analytics, API Monitor Statistics, Baseline, Billing, Browser Monitor Statistics, Browser Monitors, Calls, Certificates, and 47 more. Each is listed below with its method, path, parameters, and response codes.
Analytics 3
GET
/api/3/project/analytics/calls-monthly
Project-Calls-Monthly
GET
/api/3/organizations/{org_id}/analytics/slow-calls-daily
Org-Slow-Calls-Daily-Csv
GET
/api/3/organizations/{org_id}/analytics/slow-calls-monthly
Org-Slow-Calls-Monthly
API Monitor Statistics 4
Aggregate statistics for API Monitors
POST
/api/3/monitors/api/{monitor_id}/stats/performance
Aggregate performance metrics for an API monitor over a window
POST
/api/3/monitors/api/{monitor_id}/stats/dns-diagnostics
DNS diagnostics for an API monitor over a window
POST
/api/3/monitors/api/stats/performance
Aggregate performance metrics across all API monitors in the project
POST
/api/3/monitors/api/stats/dns-diagnostics
DNS diagnostics across all API monitors in the project
Baseline 2
GET
/api/3/baseline/dailies/{date}
Baseline-Dailies
GET
/api/3/baseline/hourlies
Baseline-Hourlies
Billing 4
GET
/api/3/organizations/{org_id}/billing/usage-counts
Org-Billing-Usage-Counts
GET
/api/3/organizations/{org_id}/billing/quota
Org-Billing-Quota
GET
/api/3/projects/billing/usage-counts
Project-Billing-Usage-Counts
GET
/api/3/projects/billing/quota
Project-Billing-Quota
Browser Monitor Statistics 6
Aggregate statistics for Browser Monitors
POST
/api/3/monitors/browser/{monitor_id}/stats/performance
Aggregate performance metrics for a monitor over a window
POST
/api/3/monitors/browser/{monitor_id}/stats/resources
Aggregate resource-level data from resourcerequests for a monitor
POST
/api/3/monitors/browser/{monitor_id}/stats/sessions
Query the top-N raw pagemetrics rows sorted by the chosen metric
POST
/api/3/monitors/browser/stats/performance
Aggregate performance metrics across all browser monitors in the project
POST
/api/3/monitors/browser/stats/resources
Aggregate resource-level data across all browser monitors in the project
POST
/api/3/monitors/browser/stats/sessions
Top-N raw pagemetrics rows across all browser monitors in the project
Browser Monitors 5
Manage Browser Monitors. Browser Monitors load a target URL in a real browser (Chromium, Firefox, or WebKit) and measure its availability and performance. Use them to monitor page…
GET
/api/3/monitors/browser/
List all Browser Monitors for a project
POST
/api/3/monitors/browser/
Create a new Browser Monitor
GET
/api/3/monitors/browser/{monitor_id}
Read a Browser Monitor by ID
PUT
/api/3/monitors/browser/{monitor_id}
Update an existing Browser Monitor
DELETE
/api/3/monitors/browser/{monitor_id}
Delete an existing Browser Monitor
Calls 13
API call (test) definitions
POST
/api/3/calls/{call_id}/update-kms-helper
Update-Kms-Helper
GET
/api/2/calls/
List-Calls
POST
/api/2/calls/
Create-Call
POST
/api/2/calls/build/curl
Build-Call-From-Curl
GET
/api/2/calls/auth/{sc_key_str}/
List-Calls-By-Auth
GET
/api/2/calls/{call_id}/
Get-Call
PUT
/api/2/calls/{call_id}/
Update-Call
DELETE
/api/2/calls/{call_id}/
Delete-Call
POST
/api/2/calls/{call_id}/rundeprecated
Run-Call-V2
GET
/api/2/calls/{call_id}/variables/used
Get-Call-Variables-Used
GET
/api/2/calls/{call_id}/variables/set
Get-Call-Variables-Set
GET
/api/2/calls/{call_id}/conditions/
Get-Call-Conditions
POST
/api/2/calls/{call_id}/conditions/
Set-Call-Conditions
Certificates 5
GET
/api/3/organizations/{org_id}/certificates/
List-Certificates
POST
/api/3/organizations/{org_id}/certificates/
Create-Certificate
GET
/api/3/organizations/{org_id}/certificates/{certificate_id}
Read-Certificate
PUT
/api/3/organizations/{org_id}/certificates/{certificate_id}
Update-Certificate
DELETE
/api/3/organizations/{org_id}/certificates/{certificate_id}
Delete-Certificate
External Sources 1
POST
/api/3/external/ingest/{source}
Ingest-External-Source
Files 10
Manage OpenAPI specifications and files which can be used as API request bodies.
POST
/api/3/files/oas
Upload-New-Oas
POST
/api/3/files/oas_url
Upload-New-Oas-From-Url
GET
/api/2/files/
List-Files
POST
/api/2/files/file
Create-File
POST
/api/2/files/url
Upload-File-From-Url
GET
/api/2/files/{key_str}/content
Get-File-Content
GET
/api/2/files/{key_str}/
Get-File
POST
/api/2/files/{key_str}/
Update-File
DELETE
/api/2/files/{key_str}/
Delete-File
POST
/api/2/files/{key_str}/file
Replace-File-Content
Governance 12
GET
/api/3/governance/changes
List-Changes
POST
/api/3/governance/conformance/{spec}/endpoints
Manage-Endpoint-Classification
GET
/api/3/governance/conformance/{spec}/endpoints
Get-Endpoint-Classifications
GET
/api/3/governance/conformance/results
Conformance-Results
GET
/api/3/governance/conformance/data-checks
List-Data-Checks
PUT
/api/3/governance/conformance/data-checks/{check_name}
Put-Data-Check
DELETE
/api/3/governance/conformance/data-checks/{check_name}
Delete-Data-Check
GET
/api/3/governance/conformance/results/summary
Conformance-Results-Summary
POST
/api/3/governance/conformance/resolution
Update-Resolution
POST
/api/3/governance/conformance/results/evaluate
Evaluate-Most-Recent
GET
/api/3/governance/conformance/settings
List-Settings
PUT
/api/3/governance/conformance/settings
Put-Settings
Integrations 6
GET
/api/3/organizations/{org_id}/integrations/
List-Integrations-For-Org
POST
/api/3/organizations/{org_id}/integrations/
Create-Integration
GET
/api/3/organizations/{org_id}/integrations/{id}
Get-Integration-By-Id
PUT
/api/3/organizations/{org_id}/integrations/{id}
Update-Integration
DELETE
/api/3/organizations/{org_id}/integrations/{id}
Delete-Integration
POST
/api/3/integrations/datadog/authenticate
Authenticate-Datadog-Integration
Inventory 3
GET
/api/3/inventory
List-Inventory
GET
/api/3/inventory/coverage
Oas-Coverage
GET
/api/3/inventory/endpoints/{file_id}
Oas-Endpoints
MCP Monitor Statistics 2
Aggregate statistics for MCP Monitors
POST
/api/3/monitors/mcp/{monitor_id}/stats/performance
Aggregate performance metrics for an MCP monitor over a window
POST
/api/3/monitors/mcp/stats/performance
Aggregate performance metrics across all MCP monitors in the project
MCP Monitors 6
Manage MCP Monitors. MCP Monitors test MCP servers by running a configurable sequence of steps (e.g. listing tools, calling a tool) against a target HTTP(S) URL.
GET
/api/3/monitors/mcp/
List all MCP Monitors for a project
POST
/api/3/monitors/mcp/
Create a new MCP Monitor
GET
/api/3/monitors/mcp/{monitor_id}
Read an MCP Monitor by ID
PUT
/api/3/monitors/mcp/{monitor_id}
Update an existing MCP Monitor
PATCH
/api/3/monitors/mcp/{monitor_id}
Patch an existing MCP Monitor
DELETE
/api/3/monitors/mcp/{monitor_id}
Delete an existing MCP Monitor
Monitors 3
List, read, and trigger monitors. This resource provides a unified view across all monitor types (API, Browser, MCP, etc.) for a project. Use the type-specific endpoints to create…
GET
/api/3/monitors/
List all Monitors for a project
GET
/api/3/monitors/{monitor_id}
Read a Monitor by ID
POST
/api/3/monitors/{monitor_id}/run
Trigger a Monitor to run now
Downtimes 4
GET
/api/3/organizations/{org_id}/downtimes
List-Org-Downtimes
POST
/api/3/organizations/{org_id}/downtimes
Create-Org-Downtime
PUT
/api/3/organizations/{org_id}/downtimes/{downtime_id}
Update-Org-Downtime
DELETE
/api/3/organizations/{org_id}/downtimes/{downtime_id}
Delete-Org-Downtime
Projects 7
Manage a project.
GET
/api/3/project/security-profiles
List-Security-Profiles-For-Project
GET
/api/3/project/agents
List-Agents-For-Project
GET
/api/2/organizations/{org_id}/projects/
List-Projects-In-Org
POST
/api/2/organizations/{org_id}/projects/
Create-Project-In-Org
DELETE
/api/2/organizations/{org_id}/projects/{project_key_str}/
Delete-Project-From-Org
GET
/api/2/projects/{project_key_str}/
Get-Project
POST
/api/2/projects/{project_key_str}/
Update-Project
Remote Agents 6
GET
/api/3/agents/
List Agents
POST
/api/3/agents/
Create Agent
GET
/api/3/agents/{agent_id}
Agent By Id
PUT
/api/3/agents/{agent_id}
Update Agent
DELETE
/api/3/agents/{agent_id}
Delete Agent
GET
/api/3/agents/{agent_id}/config
Agent Config By Id
Results 10
Raw test execution results
GET
/api/3/results/{result_id}/content/{path}
Get-Result-Content
GET
/api/3/results/{result_id}/screenshot
Get-Result-Screenshot
GET
/api/2/results/
List-Results
GET
/api/2/results/call/{test_key_str}/
List-Results-By-Call
GET
/api/2/results/hook/{hook_key_str}/
List-Results-By-Hook
GET
/api/2/results/{result_key_str}/
Get-Result
GET
/api/2/results/{result_key_str}/content
Get-Result-Content
GET
/api/2/results/{result_key_str}/pcap
Get-Result-Pcap
GET
/api/2/calls/{test_key_str}/results
List-Results-By-Call-Alias
GET
/api/2/hooks/{hook_key_str}/results
List-Results-By-Hook-Alias
Schedules 23
Manage schedules and their scheduled downtimes.
GET
/api/3/schedules/
List-Schedules
POST
/api/3/schedules/
Create-Schedule
GET
/api/3/schedules/{schedule_id}
Get-Schedule
PUT
/api/3/schedules/{schedule_id}
Update-Schedule
DELETE
/api/3/schedules/{schedule_id}
Delete-Schedule
POST
/api/3/schedules/{schedule_id}/targets/{target_id}
Add-Call-To-Schedule
DELETE
/api/3/schedules/{schedule_id}/targets/{target_id}
Remove-Call-From-Schedule
GET
/api/2/schedules/call/{call_id}/
List-Schedules-By-Call
GET
/api/2/schedules/workflow/{workflow_id}/
List-Schedules-By-Workflow
GET
/api/2/schedules/deprecated
List-Schedules
POST
/api/2/schedules/deprecated
Create-Schedule
GET
/api/2/schedules/{schedule_id}/deprecated
Get-Schedule
POST
/api/2/schedules/{schedule_id}/deprecated
Update-Schedule
DELETE
/api/2/schedules/{schedule_id}/deprecated
Delete-Schedule
POST
/api/2/schedules/{schedule_id}/call/{call_id}deprecated
Ensure-Schedule-Call
DELETE
/api/2/schedules/{schedule_id}/call/{call_id}deprecated
Remove-Schedule-Call
POST
/api/2/schedules/{schedule_id}/run/{workflow_id}deprecated
Ensure-Schedule-Workflow
DELETE
/api/2/schedules/{schedule_id}/run/{workflow_id}deprecated
Remove-Schedule-Workflow
GET
/api/2/schedules/{schedule_id}/downtime/
List-Schedule-Downtimes
POST
/api/2/schedules/{schedule_id}/downtime/
Create-Schedule-Downtime
GET
/api/2/schedules/downtime/{downtime_id}/
Get-Schedule-Downtime
POST
/api/2/schedules/downtime/{downtime_id}/
Update-Schedule-Downtime
DELETE
/api/2/schedules/downtime/{downtime_id}/
Delete-Schedule-Downtime
Service Accounts 8
GET
/api/3/organizations/{org_id}/service_accounts
List-Service-Accounts
POST
/api/3/organizations/{org_id}/service_accounts
Create-Service-Account
GET
/api/3/organizations/{org_id}/service_accounts/{service_account_id}
Get-Service-Account
DELETE
/api/3/organizations/{org_id}/service_accounts/{service_account_id}
Delete-Service-Account
PUT
/api/3/organizations/{org_id}/service_accounts/{service_account_id}/roles
Update-Service-Account-Roles
POST
/api/3/organizations/{org_id}/service_accounts/{service_account_id}/rotate_secret
Rotate-Service-Account-Secret
PUT
/api/3/organizations/{org_id}/service_accounts/{service_account_id}/projects/{project_id}
Grant-Service-Account-Project-Access
DELETE
/api/3/organizations/{org_id}/service_accounts/{service_account_id}/projects/{project_id}
Revoke-Service-Account-Project-Access
Suppliers 4
GET
/api/3/suppliers
List-Suppliers
GET
/api/3/project/suppliers
Get-Project-Suppliers
PUT
/api/3/project/suppliers
Put-Project-Suppliers
GET
/api/3/project/suppliers/results
Get-Suppliers-Results
Webhooks 18
Manage project-level webhooks that fire on monitor results.
GET
/api/3/webhooks/
List-Webhooks
POST
/api/3/webhooks/
Create-Webhook
GET
/api/3/webhooks/{webhook_id}
Get-Webhook
PUT
/api/3/webhooks/{webhook_id}
Update-Webhook
DELETE
/api/3/webhooks/{webhook_id}
Delete-Webhook
GET
/api/2/webhooks/typesdeprecated
List-Webhook-Types-V2
GET
/api/2/webhooks/types/{type}deprecated
Get-Webhook-Type-Properties-V2
GET
/api/2/webhooks/deprecated
List-Webhooks-V2
PUT
/api/2/webhooks/deprecated
Create-Webhook-V2
POST
/api/2/webhooks/snooze/{web_hook_key_str}
Snooze-Webhook-V2
GET
/api/2/webhooks/{web_hook_key_str}deprecated
Get-Webhook-V2
POST
/api/2/webhooks/{web_hook_key_str}deprecated
Update-Webhook-V2
DELETE
/api/2/webhooks/{web_hook_key_str}deprecated
Delete-Webhook-V2
GET
/api/2/calls/{test_key_str}/webhooks/deprecated
List-Call-Webhooks-V2
PUT
/api/2/calls/{test_key_str}/webhooks/deprecated
Create-Call-Webhook-V2
GET
/api/2/calls/{test_key_str}/webhooks/{web_hook_key_str}deprecated
Get-Call-Webhook-V2
POST
/api/2/calls/{test_key_str}/webhooks/{web_hook_key_str}deprecated
Update-Call-Webhook-V2
DELETE
/api/2/calls/{test_key_str}/webhooks/{web_hook_key_str}deprecated
Delete-Call-Webhook-V2
Workflows 11
Manage workflows.
GET
/api/3/workflows/{workflow_id}/locations
Get-Workflow-Locations
POST
/api/3/workflows/{workflow_id}/run
Run-Workflow
GET
/api/2/workflows/call/{call_id}/
List-Workflows-By-Call
GET
/api/2/workflows/
List-Workflows
POST
/api/2/workflows/
Create-Workflow
GET
/api/2/workflows/results/{result_key_str}/
Get-Workflow-Result
GET
/api/2/workflows/{workflow_id}/results/
List-Workflow-Results-By-Workflow
GET
/api/2/workflows/{workflow_id}/
Get-Workflow
POST
/api/2/workflows/{workflow_id}/
Update-Workflow
DELETE
/api/2/workflows/{workflow_id}/
Delete-Workflow
POST
/api/2/workflows/{workflow_key_str}/rundeprecated
Run-Workflow-V2
Account 14
View and update the caller's own Auth0 account profile.
GET
/api/2/account/
Get-Account
PUT
/api/2/account/
Update-Account-Put
GET
/api/2/account/billingdeprecated
Get-Account-Billing
GET
/api/2/account/quotadeprecated
Get-Account-Quota
POST
/api/2/account/verify
Verify-Account-Email
POST
/api/2/account/reset_password
Reset-Account-Password
GET
/api/2/account/projects
List-Account-Projects
POST
/api/2/account/projects
Create-Account-Project
GET
/api/2/account/subscription/proj/{sub_id}
Get subscription for a project
POST
/api/2/account/subscription/proj/{sub_id}
Update subscription for a project
GET
/api/2/account/subscription/proj/{sub_id}/usage
Get usage statistics for a project subscription
GET
/api/2/account/subscription/org/{sub_id}
Get subscription for an organisation
POST
/api/2/account/subscription/org/{sub_id}
Update subscription for an organisation
GET
/api/2/account/subscription/org/{sub_id}/usage
Get usage statistics for an organisation subscription
Account Settings 6
Per-project configurable settings catalogs (e.g. latency SLA thresholds).
GET
/api/2/account-settings/
List-Account-Setting-Catalogs
GET
/api/2/account-settings/{catalog_name}
Get-Account-Setting-Catalog
DELETE
/api/2/account-settings/{catalog_name}
Reset-Account-Setting-Catalog
GET
/api/2/account-settings/{catalog_name}/{variable_name}
Get-Account-Setting-Variable
POST
/api/2/account-settings/{catalog_name}/{variable_name}
Set-Account-Setting-Variable
DELETE
/api/2/account-settings/{catalog_name}/{variable_name}
Delete-Account-Setting-Variable
Agents 7
Shared / community remote agent registry (list + info + admin-only by-key operations).
GET
/api/2/agents/
List-Agents
GET
/api/2/agents/info
Agents-Info
GET
/api/2/agents/{agent_key_str}/
Get-Agent
POST
/api/2/agents/{agent_key_str}/
Update-Agent
GET
/api/2/agents/{agent_key}/
Get a remote agent
POST
/api/2/agents/{agent_key}/
Update a remote agent
DELETE
/api/2/agents/{agent_key}/
Delete a remote agent
API Keys 3
Create, list and delete the API keys bound to a project.
GET
/api/2/api_keys/
List-Api-Keys
POST
/api/2/api_keys/
Create-Api-Key
DELETE
/api/2/api_keys/{key_str}/
Delete-Api-Key
Audits 3
Audit log
GET
/api/2/audits/
List-Audits
GET
/api/2/audits/organization/{org_id}/
List-Audits-By-Org
GET
/api/2/audits/resource/{key_str}/
List-Audits-By-Resource
Auth Settings 6
Authentication / service configuration
GET
/api/2/auth/
List-Auth-Settings
POST
/api/2/auth/
Create-Auth-Setting
GET
/api/2/auth/domain/{domain}/
List-Auth-Settings-By-Domain
GET
/api/2/auth/{sc_key}/
Get-Auth-Setting
POST
/api/2/auth/{sc_key}/
Update-Auth-Setting
DELETE
/api/2/auth/{sc_key}/
Delete-Auth-Setting
Auth Tokens 6
GET
/api/2/tokens/
List-Auth-Tokens
POST
/api/2/tokens/
Create-Auth-Token
GET
/api/2/tokens/auth/{sc_key}/
List-Auth-Tokens-By-Auth-Setting
GET
/api/2/tokens/{token_key}/
Get-Auth-Token
POST
/api/2/tokens/{token_key}/
Update-Auth-Token
DELETE
/api/2/tokens/{token_key}/
Delete-Auth-Token
Stats 11
Per-call performance and pass/fail statistics
GET
/api/2/calls/{call_id}/stats/
Get-Call-Stats
GET
/api/2/calls/{call_id}/stats/since
Get-Call-Stats-Since
GET
/api/2/calls/{call_id}/stats/before
Get-Call-Stats-Before
GET
/api/2/calls/{call_id}/stats/http_codes
Get-Call-Http-Codes
GET
/api/2/calls/{call_id}/stats/failures
Get-Call-Failures
GET
/api/2/calls/{call_id}/stats/passfail
Get-Call-Passfail
GET
/api/2/calls/{call_id}/stats/passfail_total
Get-Call-Passfail-Total
GET
/api/2/calls/{call_id}/stats/passfail_range
Get-Call-Passfail-Range
GET
/api/2/calls/{call_id}/stats/legacy/passfail
Get-Call-Legacy-Passfail
GET
/api/2/calls/{call_id}/stats/legacy/passfail_range
Get-Call-Legacy-Passfail-Range
GET
/api/2/calls/{call_id}/stats/metrics/{location_id}/
Get-Call-Metrics
Crypto Utilities 4
Utility endpoints for decoding/signing JWTs, HMAC digests and RSA signatures.
POST
/api/2/jwt/decode
Decode-Jwt
POST
/api/2/jwt/encode
Encode-Jwt
POST
/api/2/hash/hmac
Hmac-Hash
POST
/api/2/sign/rsa
Rsa-Sign
Session 1
Session endpoints preserved from the legacy API.
GET
/api/2/logoutdeprecated
Logout
Conditions 2
Project-default post-test conditions.
GET
/api/2/conditions/
Get-Project-Conditions
POST
/api/2/conditions/
Set-Project-Conditions
Environment 9
Manage per-project environment workspaces and variables.
GET
/api/2/environment/
List-Environment-Workspaces
PUT
/api/2/environment/
Create-Environment-Workspace
GET
/api/2/environment/{workspace_name}
List-Environment-Variables
PUT
/api/2/environment/{workspace_name}
Create-Environment-Variable
POST
/api/2/environment/{workspace_name}
Update-Environment-Workspace-Title
DELETE
/api/2/environment/{workspace_name}
Delete-Environment-Workspace
GET
/api/2/environment/{workspace_name}/{variable_name}
Get-Environment-Variable
POST
/api/2/environment/{workspace_name}/{variable_name}
Update-Environment-Variable
DELETE
/api/2/environment/{workspace_name}/{variable_name}
Delete-Environment-Variable
Export 2
Export and re-tag a project's configuration.
GET
/api/2/export/
Export-Project
POST
/api/2/export/tag
Tag-Project-Entities
Import 2
Import a project's configuration from an export bundle.
POST
/api/2/import/
Import-Project
POST
/api/2/import/sample
Import-Sample-Projects
Hooks 5
Manage inbound hooks: workflow triggers that run when their public URL receives a request.
GET
/api/2/hooks/
List-Hooks
PUT
/api/2/hooks/
Create-Hook
GET
/api/2/hooks/{hook_key_str}
Get-Hook
POST
/api/2/hooks/{hook_key_str}
Update-Hook
DELETE
/api/2/hooks/{hook_key_str}
Delete-Hook
Insights 6
Pre-computed API insights reports, rankings and outlier detail.
GET
/api/2/insights/
List-Insights
GET
/api/2/insights/rank/
List-Insights-Rank
GET
/api/2/insights/rank/history
List-Insights-Rank-History
GET
/api/2/insights/call/{call_id}/
Get-Call-Insights
GET
/api/2/insights/{filename}/outliers
Get-Insights-Outliers
GET
/api/2/insights/{filename}/
Get-Insights
Manage 2
Copy or move resources (calls, workflows, auths, reports) between projects.
POST
/api/2/manage/copy
Copy-Resources
POST
/api/2/manage/move
Move-Resources
Invites 10
Manage and accept invites to join the platform.
POST
/api/2/account/invite/{invite_key_str}
Accept-Invite
DELETE
/api/2/account/invite/{invite_key_str}
Reject-Invite
GET
/api/2/account/invite/{invite_id}/{invite_secret}/
Verify-Invite-Secret
POST
/api/2/account/invite/{invite_id}/{invite_secret}/
Accept-Invite-Secret
GET
/api/2/organizations/{org_id}/invites/
List-Org-Invites
POST
/api/2/organizations/{org_id}/invites/
Create-Org-Invite
DELETE
/api/2/organizations/{org_id}/invites/{invite_key_str}/
Delete-Org-Invite
GET
/api/2/projects/{project_key_str}/invites/
List-Project-Invites
POST
/api/2/projects/{project_key_str}/invites/
Create-Project-Invite
DELETE
/api/2/projects/{project_key_str}/invites/{invite_key_str}/
Delete-Project-Invite
Notifications 4
Issue notifications raised about monitors, results, and workflows.
GET
/api/2/notifications/
List-Notifications
GET
/api/2/notifications/call/{test_key_str}/
List-Notifications-By-Call
GET
/api/2/notifications/{key_str}/
Get-Notification
POST
/api/2/notifications/{key_str}/
Update-Notification
Users (admin) 4
User management
GET
/api/2/users/username/{username}/
Get-User-By-Username
GET
/api/2/users/{user_key_str}/
Get-User
POST
/api/2/users/{user_key_str}/
Update-User
DELETE
/api/2/users/{user_key_str}/
Delete-User
OpenAPI 2
OpenAPI validation
POST
/api/2/openapi/tag
Tag-Project-For-Openapi
POST
/api/2/openapi/validate/{result_key_str}deprecated
Validate-Openapi
Organizations 6
Manage organizations and their members.
GET
/api/2/organizations/
List-Orgs
GET
/api/2/organizations/{org_id}/
Get-Org
POST
/api/2/organizations/{org_id}/
Update-Org
GET
/api/2/organizations/{org_id}/accounts/
List-Accounts-In-Org
GET
/api/2/organizations/{org_id}/accounts/{account_id}/
Get-Account-In-Org
DELETE
/api/2/organizations/{org_id}/accounts/{account_id}/
Delete-Account-From-Org
Project Access 6
Manage direct account access grants on projects.
GET
/api/2/organizations/{org_id}/projects/access
List-Project-Access-By-Org
GET
/api/2/projects/{project_key_str}/access/
List-Project-Access
POST
/api/2/projects/{project_key_str}/access/
Create-Project-Access
GET
/api/2/projects/{project_key_str}/access/{project_access_id}/
Get-Project-Access
POST
/api/2/projects/{project_key_str}/access/{project_access_id}/
Update-Project-Access
DELETE
/api/2/projects/{project_key_str}/access/{project_access_id}/
Delete-Project-Access
Organization Roles 4
Manage role-based access grants across an organization's projects.
GET
/api/2/organizations/{org_id}/roles/
List-Org-Roles
POST
/api/2/organizations/{org_id}/roles/
Create-Org-Role
DELETE
/api/2/organizations/{org_id}/roles/{role_id}/
Delete-Org-Role
GET
/api/2/organizations/{org_id}/roles/access
List-Project-Roles-By-Org
Project Setup 3
The setup of the current project — the project selected by the Apimetrics-Project-Id header (or bound to the API key).
GET
/api/2/project/
Get-Current-Project
POST
/api/2/project/
Update-Current-Project
PUT
/api/2/project/
Replace-Current-Project
Project SLOs 3
Service level objectives for the current project.
GET
/api/2/project/slo/
Get-Project-Slo
POST
/api/2/project/slo/
Update-Project-Slo
DELETE
/api/2/project/slo/
Delete-Project-Slo
Project Synopsis 2
Pre-aggregated pass/fail, timing and insight synopsis for the current project.
GET
/api/2/project/synopsis
Get-Project-Synopsis
GET
/api/2/project/organization/{org_id}/
Get-Organization-Synopsis
Project Roles 5
Manage role-based access grants on projects.
GET
/api/2/projects/{project_key_str}/roles/
List-Project-Roles
POST
/api/2/projects/{project_key_str}/roles/
Create-Project-Role
GET
/api/2/projects/{project_key_str}/roles/{project_role_id}/
Get-Project-Role
POST
/api/2/projects/{project_key_str}/roles/{project_role_id}/
Update-Project-Role
DELETE
/api/2/projects/{project_key_str}/roles/{project_role_id}/
Delete-Project-Role
Project Subscriptions 6
Per-account per-project email digest subscriptions (daily / weekly / monthly).
POST
/api/2/project-subscriptions/
Subscribe-To-Project-Emails
DELETE
/api/2/project-subscriptions/
Unsubscribe-From-Project-Emails
GET
/api/2/project-subscriptions/projects
List-Projects-Subscribed
GET
/api/2/project-subscriptions/projects/{level}
List-Projects-Subscribed-At-Level
GET
/api/2/project-subscriptions/accounts/project/{project_key_str}
List-Accounts-Subscribed
GET
/api/2/project-subscriptions/accounts/project/{project_key_str}/{level}
List-Accounts-Subscribed-At-Level
Reports 5
Report (dashboard) definitions grouping API calls
GET
/api/2/reports/
List-Reports
POST
/api/2/reports/
Create-Report
GET
/api/2/reports/{report_id}/
Get-Report
PUT
/api/2/reports/{report_id}/
Update-Report
DELETE
/api/2/reports/{report_id}/
Delete-Report
Schemas 560
The contract defines 560 schemas that model the data the API accepts and returns. The most detailed are UserResponse (28 properties), WebhookParameters (26 properties), InsightsReportApi (19 properties), ResultSynopsisMeta (18 properties). Each schema is shown below with its type and property counts.
AccountAccessListMeta
object
2 properties
1 required
AccountAccessListResponse
object
2 properties
2 required
AccountAccessResponse
object
7 properties
3 required
AccountInviteResponse
object
11 properties
4 required
AccountProfileResponse
object
5 properties
AccountProjectAccessResponse
object
A single project the account can reach. Direct grants (AccountProject) carry accountid/accountemail; org-role grants (ProjectRole) carry roleid instead.
8 properties
2 required
AccountProjectsMeta
object
7 properties
1 required
AccountProjectsResponse
object
3 properties
3 required
AgentInfoResponse
object
4 properties
4 required
AgentListResponse
object
2 properties
2 required
AgentLocation
array
AgentResponse
object
3 properties
3 required
AlertCondition
string
ApiKeyListMeta
object
3 properties
1 required
ApiKeyListResponse
object
2 properties
2 required
ApiKeyResponse
object
A single API key. apikey is the raw secret and is only meaningfully populated on create (and echoed on delete); id is the urlsafe key.
8 properties
4 required
ApiSchedule
object
2 properties
2 required
ApiScheduleMeta
object
6 properties
6 required
ApiScheduleSpec
object
5 properties
5 required
ApiWebHook
object
3 properties
3 required
ApiWebHookMeta
object
9 properties
9 required
ApimetricsApiWebHookParameters
object
2 properties
1 required
ApimetricsApiWebHookSpec
object
4 properties
3 required
ApimetricsTokenWebHookParameters
object
1 property
1 required
ApimetricsTokenWebHookSpec
object
4 properties
3 required
ApimetricsWorkflowWebHookParameters
object
2 properties
1 required
ApimetricsWorkflowWebHookSpec
object
4 properties
3 required
AuthConfigKeys
object
2 properties
AuthConfigKeysInput
object
2 properties
AuthConfigListMeta
object
3 properties
1 required
AuthConfigListResponse
object
2 properties
2 required
AuthConfigMeta
object
9 properties
AuthConfigMetaInput
object
5 properties
AuthConfigResponse
object
4 properties
4 required
AuthConfigSettings
object
2 properties
1 required
AuthConfigSettingsInput
object
2 properties
AuthDocumentation
object
4 properties
BackoffMethod
string
BigPandaWebHookParameters
object
3 properties
2 required
BigPandaWebHookSpec
object
4 properties
3 required
BillingMeta
object
4 properties
1 required
BillingResponse
object
GET /api/2/account/billing -- everything the caller can bill for.
2 properties
1 required
BillingResult
object
One billable entity (an org the caller can bill, or an owned project).
6 properties
5 required
Body_upload-new-oas
object
1 property
1 required
BreakdownKind
string
httpcodes / legacy/passfail — no YEAR.
BrowserTestSetupListResults
object
1 property
1 required
BrowserTestSetupRepr
object
3 properties
3 required
BuildFromCurlBody
object
1 property
1 required
COMPARATORS
string
CallCreateBody
object
3 properties
2 required
CallListMetaResponse
object
3 properties
2 required
CallListResponse
object
2 properties
2 required
CallMetaResponse
object
12 properties
4 required
CallParameterResponse
object
2 properties
2 required
CallRequestResponse
object
8 properties
2 required
CallResponse
object
3 properties
3 required
CallRunBody
object
Body for POST/PUT /api/2/calls/{callid}/run. Matches the legacy actionrun JSON Schema (additionalProperties=false).
3 properties
CallRunPayload
object
5 properties
4 required
CallUpdateBody
object
3 properties
CatalogListResponse
object
2 properties
2 required
CatalogSummary
object
One entry in the top-level catalog list.
4 properties
4 required
CatalogVariablesResponse
object
2 properties
2 required
CertificateListMeta
object
1 property
1 required
CertificateListResults
object
2 properties
2 required
CertificateMetadata
object
Certificate metadata for responses which don't need the actual values.
14 properties
13 required
ConditionalModel
object
8 properties
2 required
ConditionsMeta
object
3 properties
ConditionsResponse
object
3 properties
1 required
ConformanceAxiomWebHookParameters
object
2 properties
2 required
ConformanceAxiomWebHookSpec
object
4 properties
3 required
ConformanceDatadogWebHookParameters
object
1 property
1 required
ConformanceDatadogWebHookSpec
object
4 properties
3 required
ConformanceEmailWebHookParameters
object
1 property
1 required
ConformanceEmailWebHookSpec
object
4 properties
3 required
ConformanceGenericWebHookParameters
object
3 properties
1 required
ConformanceGenericWebHookSpec
object
4 properties
3 required
ConformanceOpentelemetryWebHookParameters
object
4 properties
1 required
ConformanceOpentelemetryWebHookSpec
object
4 properties
3 required
ConformanceResolutionRequest
object
4 properties
3 required
ConformanceSettingsRequest
object
3 properties
3 required
ConformanceSlackWebHookParameters
object
2 properties
1 required
ConformanceSlackWebHookSpec
object
4 properties
3 required
ConformanceSummaryEmailWebHookParameters
object
1 property
1 required
ConformanceSummaryEmailWebHookSpec
object
4 properties
3 required
ConformanceSummaryGenericWebHookParameters
object
3 properties
1 required
ConformanceSummaryGenericWebHookSpec
object
4 properties
3 required
ConformanceSummarySlackWebHookParameters
object
2 properties
1 required
ConformanceSummarySlackWebHookSpec
object
4 properties
3 required
CopyMoveRequest
object
Body shape for both /api/2/manage/copy and /api/2/manage/move.
4 properties
3 required
CopyMoveResponse
object
Response shape for both endpoints. Field semantics match the Py2 handler: info -- success messages, one per cloned/moved entity. warnings -- non-blocking advis…
6 properties
3 required
CoverageSettings
object
3 properties
3 required
CreateAccountProjectBody
object
1 property
CreateAgentRequest
object
12 properties
5 required
CreateApiKeyBody
object
Create payload. accesslevel is the only accepted field (there is no key name); an unknown field is rejected. Omitting accesslevel defaults the key to VIEWER (b…
1 property
CreateAuthConfigRequest
object
3 properties
CreateHookRequest
object
6 properties
1 required
CreateIntegration
object
3 properties
3 required
CreateOrgInviteBody
object
4 properties
1 required
CreateOrgRoleBody
object
2 properties
1 required
CreateProjectAccessBody
object
3 properties
CreateProjectBody
object
4 properties
CreateProjectInviteBody
object
3 properties
1 required
CreateProjectRoleBody
object
3 properties
2 required
CreateServiceAccountBody
object
2 properties
1 required
CreateTokenRequest
object
2 properties
CreateVariableBody
object
2 properties
CreateWebHookBody
object
4 properties
4 required
CreateWebHookMeta
object
4 properties
1 required
CreateWebHookRequest
object
2 properties
2 required
CreateWorkspaceBody
object
1 property
DataCheckPutRequest
object
3 properties
3 required
DatadogWebHookParameters
object
2 properties
1 required
DatadogWebHookSpec
object
4 properties
3 required
DatadogeventWebHookParameters
object
2 properties
1 required
DatadogeventWebHookSpec
object
4 properties
3 required
DatadogintegrationWebHookParameters
object
1 property
1 required
DatadogintegrationWebHookSpec
object
4 properties
3 required
DeleteOrgRoleResponse
object
1 property
1 required
DeleteStatusResponse
object
1 property
1 required
DiagnosticsGroup
object
12 properties
10 required
DnsDiagnosticsMeta
object
5 properties
5 required
DnsDiagnosticsResponse
object
2 properties
2 required
DnsRequest
object
6 properties
2 required
DowntimeBodyResponse
object
5 properties
5 required
DowntimeCreateBody
object
1 property
DowntimeListMetaResponse
object
3 properties
2 required
DowntimeListResponse
object
2 properties
2 required
DowntimeMetaResponse
object
7 properties
1 required
DowntimeResponse
object
3 properties
3 required
DowntimeUpdateBody
object
1 property
EditableDowntimeBody
object
6 properties
2 required
EditableScheduleBody
object
7 properties
EditableWebHookBody
object
10 properties
EmailTemplateWebHookParameters
object
4 properties
3 required
EmailTemplateWebHookSpec
object
4 properties
3 required
EmailTextWebHookParameters
object
2 properties
1 required
EmailTextWebHookSpec
object
4 properties
3 required
EmailWebHookParameters
object
2 properties
1 required
EmailWebHookSpec
object
4 properties
3 required
EndpointClassificationRequest
object
4 properties
4 required
ExportResponse
object
The export bundle: a bare {$schema, version, project} object.
3 properties
3 required
FlowdockWebHookParameters
object
2 properties
1 required
FlowdockWebHookSpec
object
4 properties
3 required
GenericWebHookParameters
object
6 properties
1 required
GenericWebHookSpec
object
4 properties
3 required
GrantProjectAccessBody
object
1 property
1 required
GroupByDimension
string
GroupKey
object
Identifies which slice of data this group represents. Fields are present only when the request asked to group by that dimension (or, for intervalstart, when an…
3 properties
HTTPValidationError
object
1 property
HipchatWebHookParameters
object
2 properties
1 required
HipchatWebHookSpec
object
4 properties
3 required
HistoryMeta
object
3 properties
3 required
HistoryResponse
object
2 properties
2 required
HistoryRow
object
One period bucket. good/ok/bad are the score-band counts, or None for a bucket with no reports — the route serializes with excludenone so an empty bucket rende…
4 properties
1 required
HmacRequest
object
Input for an HMAC digest. Fields are optional so the legacy validation order and 400 messages are reproduced in code rather than surfaced as 422s.
3 properties
HmacResponse
object
3 properties
3 required
HookListMeta
object
3 properties
HookListResponse
object
2 properties
2 required
HookResponse
object
12 properties
5 required
HttpBreakdownResponse
object
2 properties
2 required
HydrolixWebHookParameters
object
6 properties
1 required
HydrolixWebHookSpec
object
4 properties
3 required
ImportResponse
object
The (mutated) import bundle echoed back on a successful import.
2 properties
ImportSampleResponse
object
1 property
InsightsListMeta
object
3 properties
InsightsListResponse
object
2 properties
2 required
InsightsReportApi
object
One InsightsReport rendered as the legacy convertdatastoretoapi dict: the key's filename becomes id, ownerstr becomes projectid, and start / end are renamed to…
19 properties
1 required
IntendedUse
string
InviteListMeta
object
2 properties
1 required
InviteListResponse
object
2 properties
2 required
InviteResponse
object
11 properties
InviteStatusResponse
object
1 property
1 required
JsonPathCountRule
object
6 properties
6 required
JsonPathGroupRule
object
6 properties
6 required
JsonPathRegexRule
object
7 properties
7 required
JsonPathSubstringRule
object
7 properties
7 required
JsonPathValueRule
object
7 properties
7 required
JwtDecodeResponse
object
The decoded (but unverified) parts of a JWT. Exactly one of payload or error is present: error replaces payload when the claims segment cannot be decoded.
4 properties
2 required
JwtEncodeRequest
object
Input for signing a JWT. Fields are all optional here so that the exact legacy validation order and 400 messages are reproduced in code rather than surfaced as…
7 properties
KidAlg
string
LegacyPassFailRangeResponse
object
2 properties
2 required
LegacyPassFailResponse
object
2 properties
2 required
ListStatsKind
string
As StatsKind plus RAW (per-result rows) for since/before.
MEASURES
string
METRICS
string
McpCallToolStepRepr
object
5 properties
3 required
McpGetPromptStepRepr
object
5 properties
3 required
McpListPromptsStepRepr
object
3 properties
2 required
McpListResourceTemplatesStepRepr
object
3 properties
2 required
McpListResourcesStepRepr
object
3 properties
2 required
McpListToolsStepRepr
object
3 properties
2 required
McpReadResourceStepRepr
object
4 properties
3 required
McpTestSetupListResults
object
1 property
1 required
McpTestSetupRepr
object
3 properties
3 required
McpWaitStepRepr
object
3 properties
2 required
Measure
string
MetricAggregate
object
Aggregates for one metric within one result group.
9 properties
1 required
MonthlyResultCounts
object
5 properties
5 required
MsteamsWebHookParameters
object
2 properties
1 required
MsteamsWebHookSpec
object
4 properties
3 required
NewrelicWebHookParameters
object
3 properties
2 required
NewrelicWebHookSpec
object
4 properties
3 required
NonameWebHookParameters
object
5 properties
2 required
NonameWebHookSpec
object
4 properties
3 required
NotificationListMeta
object
3 properties
2 required
NotificationListResponse
object
2 properties
2 required
NotificationResponse
object
12 properties
2 required
OpenApiFileInfo
object
Per-file validation summary, keyed by file ID in the tagger response.
7 properties
7 required
OpenTelemetryAxiomWebHookParameters
object
2 properties
2 required
OpenTelemetryAxiomWebHookSpec
object
4 properties
3 required
OpenTelemetryWebHookParameters
object
6 properties
1 required
OpenTelemetryWebHookSpec
object
4 properties
3 required
OpsgenieWebHookParameters
object
2 properties
1 required
OpsgenieWebHookSpec
object
4 properties
3 required
OpsgenieeuWebHookParameters
object
2 properties
1 required
OpsgenieeuWebHookSpec
object
4 properties
3 required
OrgAccountDeleteResponse
object
1 property
1 required
OrgAccountListMeta
object
2 properties
1 required
OrgAccountListResponse
object
2 properties
2 required
OrgAccountResponse
object
2 properties
1 required
OrgListMeta
object
2 properties
1 required
OrgListResponse
object
2 properties
2 required
OrgResponse
object
12 properties
3 required
OrgRoleListMeta
object
2 properties
1 required
OrgRoleListResponse
object
2 properties
2 required
OrgRoleResponse
object
5 properties
5 required
OrgSlowCallDaily
object
7 properties
7 required
OrgSlowCallMonthly
object
9 properties
9 required
OrgSlowCallsDaily
object
2 properties
2 required
OrgSlowCallsMetadata
object
5 properties
5 required
OrgSlowCallsMonthly
object
2 properties
2 required
OrgSynopsisInsights
object
Per-project mean of each call's insight metrics. Null on the enclosing synopsis when no included call reported a score.
5 properties
OrgSynopsisResponse
object
5 properties
5 required
OrgSynopsisResultCounts
object
Per-project sum of each call's pass/fail result counts.
5 properties
OrgSynopsisTimings
object
Per-project sum of each call's timings.overall metrics. Latency values are summed, not averaged — count is the divisor callers use to turn them into per-result…
13 properties
PagerDutyV2WebHookParameters
object
3 properties
1 required
PagerDutyV2WebHookSpec
object
4 properties
3 required
PagerDutyWebHookParameters
object
2 properties
1 required
PagerDutyWebHookSpec
object
4 properties
3 required
PassFailKind
string
passfail / passfailrange (KINDCLASSMAP) — no WEEK.
PassFailRangeResponse
object
2 properties
2 required
PassFailResponse
object
2 properties
2 required
PassFailTotalResponse
object
2 properties
2 required
PostConditionsRequest
object
2 properties
1 required
PostProjectConditionsRequest
object
1 property
1 required
ProjectAccessListMeta
object
3 properties
2 required
ProjectAccessListResponse
object
2 properties
2 required
ProjectCall
object
10 properties
10 required
ProjectCallsMetadata
object
5 properties
5 required
ProjectCallsMonthly
object
2 properties
2 required
ProjectConditionsMeta
object
1 property
ProjectConditionsResponse
object
2 properties
1 required
ProjectInviteListMeta
object
3 properties
1 required
ProjectInviteListResponse
object
2 properties
2 required
ProjectListMeta
object
3 properties
2 required
ProjectListResponse
object
2 properties
2 required
ProjectResponse
object
10 properties
8 required
ProjectRoleListMeta
object
3 properties
2 required
ProjectRoleListResponse
object
2 properties
2 required
ProjectRoleResponse
object
6 properties
6 required
ProjectRollupResponse
object
One project's rolled-up synopsis for the requested period.
6 properties
6 required
ProjectSloDeletedStatus
object
Rendered when DELETE finds no stored SLO (idempotent delete).
1 property
ProjectSloResponse
object
7 properties
7 required
ProjectSuppliersRequestBody
object
1 property
1 required
QuantileResponse
object
pandas-todict('split')-style payload (columns / index / data).
3 properties
3 required
QuotaCounts
object
The current usage counts (QuotaInfo.counts).
5 properties
5 required
QuotaLimits
object
The per-plan quota limits (QuotaInfo.quotas).
3 properties
3 required
Quotas
object
3 properties
3 required
RankMeta
object
6 properties
1 required
RankResponse
object
2 properties
2 required
RankResult
object
A ranked monitor: its latest score plus a short results history of (periodstart, score) points and the matching filenames.
14 properties
1 required
ReadAgentResponse
object
17 properties
10 required
ReadIntegration
object
7 properties
7 required
RecordCount
object
2 properties
2 required
ReportAccessResponse
object
1 property
1 required
ReportCreateBody
object
3 properties
1 required
ReportGroupResponse
object
2 properties
1 required
ReportListMetaResponse
object
3 properties
2 required
ReportListResponse
object
2 properties
2 required
ReportMetaResponse
object
8 properties
4 required
ReportResponse
object
4 properties
3 required
ReportRowResponse
object
2 properties
2 required
ReportUpdateBody
object
3 properties
ResetPasswordBody
object
1 property
ResourceTypeBreakdown
object
4 properties
1 required
ResourcesMeta
object
4 properties
2 required
ResourcesRequest
object
3 properties
2 required
ResourcesResponse
object
3 properties
2 required
ResultCategory
string
ResultDetailMeta
object
6 properties
ResultDetailResponse
object
Full result detail as returned by toapi().
2 properties
ResultListMeta
object
4 properties
2 required
ResultListResponse
object
Paginated list of result synopses.
2 properties
2 required
ResultSynopsisItem
object
3 properties
1 required
ResultSynopsisMeta
object
18 properties
ResultSynopsisTiming
object
7 properties
RotateSecretResponse
object
1 property
1 required
RsaSignRequest
object
Input for an RSA signature. Fields are optional; see HmacRequest.
3 properties
RsaSignResponse
object
2 properties
2 required
RunMonitorRequest
object
3 properties
ScheduleBodyResponse
object
7 properties
1 required
ScheduleCreateBody
object
2 properties
ScheduleListMetaResponse
object
3 properties
2 required
ScheduleListResponse
object
2 properties
2 required
ScheduleMetaResponse
object
5 properties
1 required
ScheduleResponse
object
3 properties
3 required
ScheduleUpdateBody
object
2 properties
ServiceAccountCreateResponse
object
4 properties
4 required
ServiceAccountListMeta
object
3 properties
3 required
ServiceAccountListResponse
object
2 properties
2 required
ServiceAccountMeta
object
7 properties
7 required
ServiceAccountResponse
object
3 properties
3 required
ServiceAccountSpec
object
2 properties
2 required
ServiceLevelObjectiveBody
object
7 properties
6 required
ServiceLevelObjectiveResponse
object
7 properties
6 required
SessionRow
object
8 properties
3 required
SessionsMeta
object
6 properties
5 required
SessionsRequest
object
5 properties
2 required
SessionsResponse
object
2 properties
2 required
SessionsSortBy
string
SetTagsResponse
object
2 properties
2 required
SetVariableRequest
object
1 property
1 required
SlackWebHookParameters
object
3 properties
1 required
SlackWebHookSpec
object
4 properties
3 required
SloPeriod
string
The evaluation periods the /api/2 project SLO accepts. models.projectslo.PERIODS also defines sub-day periods for the newer SLO configurations; ProjectSLO only…
SortOrder
string
StatListResponse
object
2 properties
2 required
StatResponse
object
3 properties
1 required
StatsCategory
string
Result category filter for the quantile metrics/ endpoint.
StatsKind
string
Aggregation period for stats/ and metrics/ (StatsApiHandler.VALIDKINDS).
StatsMetric
string
StatsType
string
StatusResponse
object
1 property
1 required
StatuspageWebHookParameters
object
4 properties
3 required
StatuspageWebHookSpec
object
4 properties
3 required
StoredVariableResponse
object
The response from POST / / -- the persisted entity in its convertdatastoretoapi form.
3 properties
3 required
SubDetail
object
The subscription summary (QuotaInfo.sub).
8 properties
3 required
SubscribeRequest
object
Body for POST/PUT /api/2/project-subscriptions/. Options default to all three digest levels if the caller omits the field, matching Py2's options = self.reques…
1 property
SubscriptionListResponse
object
2 properties
2 required
SubscriptionResponse
object
One row of ProjectEmailSubscription, matching Py2's convertdatastoretoapi output.
6 properties
4 required
SynopsisKind
string
The aggregation periods a synopsis blob is generated for. Legacy read kind as a free string, upper-cased it and looked it up in a dict with a daily default, so…
THRESHOLDS
string
TagProjectError
object
5 properties
4 required
TagProjectMatch
array
TagProjectResponse
object
5 properties
4 required
TestSetup2Repr
object
3 properties
3 required
ThirdPartyBucket
object
5 properties
1 required
ThresholdBody
object
5 properties
4 required
ThresholdResponse
object
5 properties
4 required
TokenData
object
2 properties
TokenDataInput
object
1 property
TokenListMeta
object
3 properties
1 required
TokenListResponse
object
2 properties
2 required
TokenMeta
object
8 properties
TokenMetaInput
object
4 properties
TokenResponse
object
3 properties
3 required
UNITS
string
UpdateAccountBody
object
8 properties
UpdateAgentRequest
object
1 property
1 required
UpdateAuthConfigRequest
object
3 properties
UpdateCurrentProjectBody
object
2 properties
UpdateHookRequest
object
5 properties
UpdateIntegration
object
2 properties
2 required
UpdateNotificationBody
object
1 property
UpdateOrgBody
object
5 properties
UpdateProjectAccessBody
object
3 properties
UpdateProjectBody
object
4 properties
UpdateProjectRoleBody
object
4 properties
UpdateProjectSloBody
object
4 properties
UpdateRequestMeta
object
4 properties
UpdateRequestSetup
object
3 properties
UpdateRolesBody
object
1 property
1 required
UpdateTokenRequest
object
2 properties
UpdateUserBody
object
1 property
UpdateVariableBody
object
1 property
UpdateWebHookBody
object
4 properties
UpdateWebHookMeta
object
4 properties
UpdateWebHookRequest
object
2 properties
UpdateWorkspaceBody
object
1 property
UploadFileResponse
object
4 properties
4 required
UploadUrl
object
1 property
1 required
Usage
object
5 properties
5 required
UsageCountsResponse
object
3 properties
3 required
UsageWeights
object
3 properties
UserResponse
object
28 properties
ValidateError
object
A single schema-validation failure, as produced by the ajv-backed schema-validator function.
5 properties
3 required
ValidateResponse
object
3 properties
1 required
ValidationError
object
5 properties
3 required
VariableEntry
object
A single variable's static config plus its current value. The current value is either the persisted override or the config's defaultvalue. Fields mirror USERSE…
7 properties
6 required
VariableFields
object
2 properties
2 required
VariableListMeta
object
3 properties
1 required
VariableListResponse
object
2 properties
2 required
VariableMeta
object
4 properties
1 required
VariableResponse
object
3 properties
3 required
VictoropsWebHookParameters
object
3 properties
1 required
VictoropsWebHookSpec
object
4 properties
3 required
WebHookBody
object
4 properties
4 required
WebHookListMeta
object
2 properties
WebHookListResponse
object
2 properties
2 required
WebHookMeta
object
9 properties
2 required
WebHookResponse
object
3 properties
3 required
WebHookType
string
WebHookTypeDescriptor
object
4 properties
4 required
WebHookTypeListResponse
object
1 property
1 required
WebHookTypeParameter
object
5 properties
2 required
WebHookTypePropertiesResponse
object
1 property
1 required
WorkflowCreateBody
object
3 properties
1 required
WorkflowDataResponse
object
3 properties
3 required
WorkflowListMetaResponse
object
3 properties
2 required
WorkflowListResponse
object
2 properties
2 required
WorkflowLocationOptions
object
7 properties
7 required
WorkflowMetaResponse
object
8 properties
4 required
WorkflowResponse
object
3 properties
3 required
WorkflowResultListMeta
object
3 properties
2 required
WorkflowResultListResponse
object
Paginated list of workflow results.
2 properties
2 required
WorkflowResultMeta
object
Per-result meta block, matching convertdatastoretoapi.
13 properties
WorkflowResultResponse
object
A single workflow result (TestRunResult).
4 properties
1 required
WorkflowRunPayload
object
9 properties
3 required
WorkflowRunRequest
object
4 properties
1 required
WorkflowSubResult
object
One test result inside a workflow run.
5 properties
WorkflowUpdateBody
object
3 properties
WorkspaceFields
object
2 properties
1 required
WorkspaceListMeta
object
3 properties
1 required
WorkspaceListResponse
object
2 properties
2 required
WorkspaceMeta
object
3 properties
1 required
WorkspaceResponse
object
3 properties
3 required
_AgentDetails
object
11 properties
1 required
_AgentMeta
object
5 properties
2 required
_CallCreateMeta
object
4 properties
1 required
_CallCreateRequest
object
8 properties
2 required
_CallUpdateMeta
object
4 properties
_CallUpdateRequest
object
8 properties
_CategoryBreakdown
object
2 properties
_DowntimeBodyFields
object
5 properties
_FileListMeta
object
3 properties
2 required
_FileListResponse
object
2 properties
2 required
_FileMeta
object
9 properties
_FileResponse
object
2 properties
2 required
_HttpBreakdownMeta
object
6 properties
3 required
_HttpBreakdownOverall
object
3 properties
_HttpBreakdownStat
object
4 properties
1 required
_LegacyPassFailMeta
object
6 properties
3 required
_PassFailCounts
object
3 properties
_PassFailMeta
object
6 properties
3 required
_PassFailRangeMeta
object
6 properties
3 required
_PassFailTotalMeta
object
4 properties
1 required
_RegionEntry
object
3 properties
2 required
_ReportAccessBody
object
3 properties
_ReportCreateMeta
object
4 properties
1 required
_ReportGroupBody
object
2 properties
1 required
_ReportRowBody
object
2 properties
2 required
_ReportUpdateMeta
object
4 properties
_RequestRepr
object
8 properties
7 required
_RunWorkflowBody
object
4 properties
_ScheduleBodyMeta
object
2 properties
_ScheduleBodySchedule
object
5 properties
_StatItem
object
One bucket (aggregated) or one result (RAW).
10 properties
2 required
_StatListMeta
object
9 properties
4 required
_StatMeta
object
6 properties
4 required
_StatValues
object
6 properties
5 required
_StoredVariablePayload
object
2 properties
2 required
_TestParameterRepr
object
2 properties
2 required
_UpdateAgentBody
object
Body accepted by POST /api/2/agents/ / (update user overrides).
8 properties
_UploadUrlBody
object
1 property
1 required
_VariableMeta
object
5 properties
_WorkflowBodyWorkflow
object
3 properties
_WorkflowCreateMeta
object
4 properties
1 required
_WorkflowUpdateMeta
object
4 properties
api2__account__billing__QuotaResponse
object
GET /api/2/account/quota -- the caller's project quota/usage. Identical to :class:SubInfo with the legacy top-level billingadminid the quota handler injects wh…
7 properties
4 required
api2__account__billing__SubInfo
object
The SubLevelManager.tojson payload, shared by quota and billing.
6 properties
4 required
api2__account_settings__settings___ListMeta
object
The list-envelope meta used by both list and get catalog responses. No projectid field here -- the Py2 handler builds the envelope by hand rather than through…
2 properties
api2__agents__agents___ListMeta
object
2 properties
api2__project_subscriptions__subscriptions___ListMeta
object
3 properties
api2__projects__proj_access__ProjectAccessResponse
object
7 properties
7 required
api3__billing__models__QuotaResponse
object
7 properties
7 required
api3__billing__models__SubInfo
object
8 properties
8 required
api3__certificates__api_models__CreateRequest
object
8 properties
4 required
api3__certificates__api_models__UpdateRequest
object
8 properties
api3__monitors__api__stats__api_models__Metric
string
api3__monitors__browser__api_models__CreateRequest
object
7 properties
2 required
api3__monitors__browser__api_models__UpdateRequest
object
2 properties
api3__monitors__browser__stats__api_models__Metric
string
api3__monitors__common__api_models__PerformanceGroup_Metric___1
object
5 properties
3 required
api3__monitors__common__api_models__PerformanceGroup_Metric___2
object
5 properties
3 required
api3__monitors__common__api_models__PerformanceGroup_Metric___3
object
5 properties
3 required
api3__monitors__common__api_models__PerformanceMeta_Metric___1
object
7 properties
6 required
api3__monitors__common__api_models__PerformanceMeta_Metric___2
object
7 properties
6 required
api3__monitors__common__api_models__PerformanceMeta_Metric___3
object
7 properties
6 required
api3__monitors__common__api_models__PerformanceRequest_Metric___1
object
9 properties
2 required
api3__monitors__common__api_models__PerformanceRequest_Metric___2
object
9 properties
2 required
api3__monitors__common__api_models__PerformanceRequest_Metric___3
object
9 properties
2 required
api3__monitors__common__api_models__PerformanceResponse_Metric___1
object
2 properties
2 required
api3__monitors__common__api_models__PerformanceResponse_Metric___2
object
2 properties
2 required
api3__monitors__common__api_models__PerformanceResponse_Metric___3
object
2 properties
2 required
api3__monitors__mcp__api_models__CreateRequest
object
9 properties
2 required
api3__monitors__mcp__api_models__UpdateRequest
object
9 properties
api3__monitors__mcp__stats__api_models__Metric
string
api3__monitors__router___ListResponse
object
2 properties
2 required
api3__monitors__router___ListResponseMeta
object
3 properties
3 required
api3__schedules__router___ListResponse
object
2 properties
2 required
api3__schedules__router___ListResponseMeta
object
3 properties
3 required
api3__service_accounts__service_accounts__ProjectAccessResponse
object
3 properties
3 required
api3__webhooks__router___ListResponse
object
2 properties
2 required
api3__webhooks__router___ListResponseMeta
object
3 properties
3 required
models__browser_call___MetaRepr
object
9 properties
6 required
models__browser_call___SetupRepr
object
3 properties
2 required
models__call___MetaRepr
object
11 properties
10 required
models__mcp_test_setup___MetaRepr
object
9 properties
7 required
models__mcp_test_setup___SetupRepr
object
5 properties
3 required
KeyStr
string
URL-safe base64 Datastore key
NullableKeyStr
string
KeyValuePair
object
2 properties
ParameterList
CallMeta
object
9 properties
CallRequest
object
8 properties
2 required
CallInput
object
2 properties
2 required
CallOutput
CallRunInput
object
3 properties
CallRunOutput
object
3 properties
ScheduleMeta
object
5 properties
ScheduleConfig
object
5 properties
ScheduleInput
object
2 properties
ScheduleOutput
DowntimeConfig
object
5 properties
2 required
DowntimeInput
object
2 properties
DowntimeMeta
object
3 properties
DowntimeOutput
WebhookParameters
object
26 properties
WebhookConfig
object
4 properties
4 required
WebhookMeta
object
7 properties
WebhookInput
object
2 properties
2 required
WebhookOutput
WebhookTypeDescription
object
3 properties
AuthMeta
object
8 properties
AuthSettings
object
2 properties
AuthKeys
object
2 properties
AuthInput
object
3 properties
2 required
AuthOutput
ResultOutput
object
7 properties
StatsOutput
object
7 properties
PassFailStats
object
5 properties
FileMeta
object
7 properties
FileOutput
object
2 properties
2 required
IncidentOutput
object
3 properties
IncidentInput
object
2 properties
WorkspaceVariable
object
2 properties
WorkspaceOutput
object
2 properties
ReportOutput
object
3 properties
ReportInput
object
2 properties
WorkflowOutput
object
3 properties
WorkflowInput
object
2 properties
AgentOutput
object
3 properties
AuditOutput
object
6 properties
OrganizationOutput
object
3 properties
OrganizationInput
object
2 properties
ProjectOutput
object
2 properties
AccountOutput
object
3 properties
ApiKeyOutput
object
3 properties
ListMeta
object
3 properties
ErrorResponse
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from APIContext 12
Other APIs APIContext publishes across the network.
APIContext Calls API
APIContext Schedules API
APIContext Webhooks API
APIContext Workflows API
APIContext Governance API
APIContext Stats API
APIContext Results API
APIContext Agents API
APIContext Projects API
APIContext Insights API
APIContext Auth Tokens API
APIContext MCP Monitors API
#API Monitoring#Conformance#Performance#Platform#SLO#Synthetic Testing
Where this information came from
This is an independent, third-party profile of APIContext Platform API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.