SLOs
Manage Service Level Objectives (SLOs) for a project, monitor, or workflow.
An SLO defines
- objectives — metric thresholds that must be met over a rolling period (e.g. availability > 99.5% per month)
- thresholds — alerts that fire when a metric degrades by more than a specified delta compared to the previous period. When an objective is breached an incident is opened; use the incidents endpoint to query the incident history for a time window.
SLOs can be defined at three different scopes:
- project — the SLO applies to all monitors in the project
- workflow — the SLO applies to all monitors in a workflow
- monitor — the SLO applies only to the specified monitor
Introduction
API for the APImetrics platform
Account
Account
Add-Call-To-Schedule
Add a target to an existing schedule.
Agent By Id
Agent By Id
Agent Config By Id
Agent Config By Id
Agents
Agents
API Keys
API Keys
Audits
Audits
Auth Settings
Auth Settings
Authenticate-Datadog-Integration
Authenticate-Datadog-Integration
Baseline-Dailies
Baseline-Dailies
Baseline-Hourlies
Baseline-Hourlies
Browser Monitors
Browser Monitors
Parse a curl command and return a call definition
Parse a curl command and return a call definition
Calls
Calls
Conditions
Conditions
Conformance-Results-Summary
Query the latest conformance result summary for a project
Conformance-Results
Query the conformance results
Create Agent
Create Agent
Create a new API key
Create a new API key
Create an authentication configuration
Create an authentication configuration
Create a new Browser Monitor
Create a new Browser Monitor
Create a condition for a specific call
Create a condition for a specific call
Create a webhook attached to a call
Create a webhook attached to a call
Create an API call
Create an API call
Create-Certificate
Create a new Certificate.
Create a project-level condition
Create a project-level condition
Create a variable in a workspace
Create a variable in a workspace
Create an environment workspace
Create an environment workspace
Upload a new file
Upload a new file
Create an incident
Create an incident
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 an organisation
Create an organisation
Create a new project
Create a new project
Create a report
Create a report
Create a downtime window for a schedule
Create a downtime window for a schedule
Create-Schedule
Create a new schedule for the project.
Create-Slo
Create a new SLO configuration.
Create-Webhook
Create a new webhook for the project.
Create a workflow
Create a workflow
Delete Agent
Delete Agent
Delete an API key
Delete an API key
Delete an authentication configuration
Delete an authentication configuration
Delete an existing Browser Monitor
Delete an existing Browser Monitor
Delete a call-level webhook
Delete a call-level webhook
Delete an API call
Delete an API call
Delete-Certificate
Delete an existing Certificate.
Delete-Data-Check
Delete data check with the given name
Delete a workspace variable
Delete a workspace variable
Delete a workspace
Delete a workspace
Delete a file
Delete a file
Delete an incident
Delete an incident
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-Project-Slo
Delete the project-scoped SLO configuration.
Delete a report
Delete a report
Delete a downtime window
Delete a downtime window
Delete-Schedule
Delete an existing schedule for this org.
Delete-Slo
Delete an SLO configuration by scope and scope_id.
Delete-Webhook
Delete an existing webhook for this project.
Delete a workflow
Delete a workflow
Environment
Environment
Evaluate-Most-Recent
Run conformance checks and summary calculation on the most recent calls
Files
Files
Get billing information for the account
Get billing information for the account
Get quota information for the account
Get quota information for the account
Get the authenticated account details
Get the authenticated account details
Get available agent location information
Get available agent location information
Get a remote agent
Get a remote agent
Get an API key (metadata only — key value not returned)
Get an API key (metadata only — key value not returned)
Get an authentication configuration
Get an authentication configuration
Get-Call-Conditions
Get the post-test conditions for an API call.
Get HTTP status code breakdown for a call
Get HTTP status code breakdown for a call
Get overall pass/fail totals for a call
Get overall pass/fail totals for a call
Get pass/fail stats per location for a call
Get pass/fail stats per location for a call
Get stats for a call before a given time
Get stats for a call before a given time
Get stats for a call since a given time
Get stats for a call since a given time
Get aggregated performance stats for a call
Get aggregated performance stats for a call
Get a call-level webhook
Get a call-level webhook
Get a single API call
Get a single API call
Get-Endpoint-Classifications
Manage the classification of endpoints for a given spec
Get a workspace variable
Get a workspace variable
Download the raw content of a file
Download the raw content of a file
Get file metadata
Get file metadata
Get an incident
Get an incident
Get-Incidents
List all incidents that were open during the specified time window.
Get-Integration-By-Id
Get-Integration-By-Id
Read a Monitor by ID
Read a Monitor by ID
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 organisation
Get-Project-Slo
Get the project-scoped SLO configuration.
Get subscription for a project
Get subscription for a project
Get-Project-Suppliers
Return the list of enabled suppliers for the selected project.
Get usage statistics for a project subscription
Get usage statistics for a project subscription
Get a report
Get a report
Get-Result-Content
Get-Result-Content
Get-Result-Screenshot
Get-Result-Screenshot
Get a downtime window
Get a downtime window
Get-Schedule
Get a specific schedule by ID.
Get-Slo
Get an SLO configuration by scope and scope_id.
Get-Suppliers-Results
Query the current supplier results for the selected project
Get parameter schema for a webhook type
Get parameter schema for a webhook type
Get-Webhook
Get a specific webhook by ID.
Get-Workflow-Locations
Get-Workflow-Locations
Get a workflow
Get a workflow
Handle Provision Existing
Handle Provision Existing
Handle Provision New
Handle Provision New
Handle Subscribe
Handle Subscribe
Handle Webhook
Handle Webhook
Import a file from a URL
Import a file from a URL
Incidents
Incidents
Ingest-External-Source
Ingest-External-Source
List all projects accessible to the account
List all projects accessible to the account
List-Agents-For-Project
List all agents accessible to a project.
List Agents
List Agents
List API keys for the account
List API keys for the account
List-Audits-By-Org
List audit records for an organization.
List-Audits-By-Resource
List audit records for a specific resource, optionally merging related kinds.
List-Audits
List audit records for the project.
List auth configs for a specific domain
List auth configs for a specific domain
List authentication configurations
List authentication configurations
List all Browser Monitors for a project
List all Browser Monitors for a project
List conditions attached to a specific call
List conditions attached to a specific call
List notifications for a specific call
List notifications for a specific call
List execution results for an API call
List execution results for an API call
List variable names that this call's conditions write
List variable names that this call's conditions write
List variable names referenced in the call definition
List variable names referenced in the call definition
List webhooks attached to a call
List webhooks attached to a call
List calls that use a specific auth config
List calls that use a specific auth config
List API calls
List API calls
List-Certificates
List metadata for all of an org's Certificates.
List-Changes
Return a list of changes within the given time range.
List conditions for the project
List conditions for the project
List-Data-Checks
List data checks for the given project
List variables in a workspace
List variables in a workspace
List environment workspaces
List environment workspaces
List uploaded files
List uploaded files
List incidents
List incidents
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 notification log entries
List notification log entries
List audit log entries for an organisation
List audit log entries for an organisation
List-Org-Downtimes
List downtimes defined on the given org.
List projects in an organisation
List projects in an organisation
List organisations the account belongs to
List organisations the account belongs to
List reports
List reports
List audit log entries for a specific resource
List audit log entries for a specific resource
List scheduled downtime windows for a schedule
List scheduled downtime windows for a schedule
List schedules that include a specific call
List schedules that include a specific call
List schedules that include a specific workflow
List schedules that include a specific workflow
List-Schedules
List schedules for the project.
List-Security-Profiles-For-Project
List-Security-Profiles-For-Project
List-Settings
Retrieve the conformance settings for a project
List-Slos
List all SLO configurations.
List-Suppliers
Return a categorised list of suppliers.
List available webhook integration types
List available webhook integration types
List-Webhooks
List webhooks for the project.
List execution results for a workflow
List execution results for a workflow
List workflows
List workflows
Manage-Endpoint-Classification
Manage the classification of endpoints for a given spec
MCP Monitors
MCP Monitors
Monitors
Monitors
Notifications
Notifications
Oas-Coverage
Return API call coverage data for OpenAPI endpoints.
Oas-Endpoints
Return a list of endpoints for the requested OpenAPI spec.
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
Organizations
Organizations
Patch an existing MCP Monitor
Patch an existing MCP Monitor
Project-Billing-Quota
Project-Billing-Quota
Project-Billing-Usage-Counts
Project-Billing-Usage-Counts
Project-Calls-Monthly
Project-Calls-Monthly
Projects
Projects
Put-Data-Check
Create or update data check with the given name
Put-Project-Suppliers
Set the list of enabled suppliers for the selected project
Put-Settings
Insert or update conformance settings for a 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
Remove-Call-From-Schedule
Remove a target from an existing schedule.
Reports
Reports
Request a password reset
Request a password reset
Results
Results
Trigger an immediate (on-demand) execution of an API call
Trigger an immediate (on-demand) execution of an API call
Trigger a Monitor to run now
Trigger a Monitor to run now
Run-Workflow
Run-Workflow
Schedules
Schedules
Set-Call-Conditions
Replace the post-test conditions for an API call.
SLOs
SLOs
Stats
Stats
Update account details
Update account details
Update Agent
Update Agent
Update an authentication configuration
Update an authentication configuration
Update an existing Browser Monitor
Update an existing Browser Monitor
Update a call-level webhook
Update a call-level webhook
Update an API call
Update an API call
Update-Certificate
Update an existing Certificate.
Update a workspace variable
Update a workspace variable
Update workspace metadata
Update workspace metadata
Update an incident
Update an incident
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-Org-Backend
Update the apimetrics-backend tag for an organization. Requires SITE_ADMIN permission.
Update-Org-Downtime
Update an existing downtime for this org.
Update subscription for an organisation
Update subscription for an organisation
Update an organisation
Update an organisation
Update-Project-Slo
Update the project-scoped SLO configuration.
Update subscription for a project
Update subscription for a project
Update a report
Update a report
Update-Resolution
Update the resolution status for a conformance result
Update a downtime window
Update a downtime window
Update-Schedule
Update an existing schedule.
Update-Slo
Update an SLO configuration by scope and scope_id.
Update-Webhook
Update an existing webhook.
Update a workflow
Update a workflow
Upload-New-Oas-From-Url
Upload a new OpenAPI spec.
Upload-New-Oas
Upload a new OpenAPI spec.
Verify the account email address
Verify the account email address
Webhooks
Webhooks
Workflows
Workflows