Skip to content
SiteQwality Docs
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Getting Started
Introduction
Sign up & first monitor
Account & team setup
Concepts & glossary
Uptime Monitoring
Overview
HTTP checks
Overview
Quickstart
Reference
How-to guides
Require N failed checks before alerting
Get alerted when page speed drops
SSL/TLS checks
Overview
Quickstart
Reference
Domain expiry checks
Overview
Quickstart
Reference
Cron checks
Overview
Quickstart
Reference
How-to guides
Understand the grace period
Send heartbeats reliably
Browser checks
Overview
Quickstart
Reference
Observability
Overview
Metrics
Overview
Quickstart
Reference
How-to guides
Chart histograms as percentiles or a heatmap
Save a metrics explorer view
Logs
Overview
Quickstart
Reference
How-to guides
Use log parsers
Find patterns and analyse volume
Save and share log views
Traces
Overview
Quickstart
Reference
How-to guides
Correlate traces with logs
Send OTLP over HTTP/protobuf
Sample traces
RUM
Overview
Quickstart
Reference
How-to guides
Segment by browser, OS, device and country
Change SDK behaviour without redeploying
Configure session filters
Upload source maps
Session Replay
Overview
Quickstart
Reference
Incident Management
Overview
Incidents
Overview
Quickstart
Reference
How-to guides
Create manual incidents
Acknowledge from the alert itself
On-call schedules
Overview
Quickstart
Reference
How-to guides
Cover holidays with rotation overrides
Escalation policies
Overview
Quickstart
Reference
Notifications
Overview
Channels reference
How-to guides
Set up personal notification rules
Maintenance windows
Overview
Quickstart
Reference
How-to guides
Schedule recurring maintenance
Status Pages
Overview
Quickstart
Reference
How-to guides
Use a custom domain
Manage subscribers
Dashboards
Overview
Quickstart
Widget reference
Integrations
Overview
Slack
Microsoft Teams
Discord
Telegram
Google Chat
Mattermost
PagerDuty
OpsGenie
Pushover
Pushbullet
Webhooks
Partners
Partner program
Client accounts
Working in a client account
Monthly client reports
Enterprise
Overview
SCIM role mapping
M2M API clients
Customer audit log
CSV exports
SLA reports
SDK Reference
Overview
Reference
API Reference
Overview
HTTP Monitors
Overview
Create an HTTP monitor.
Pre-signed URL for the full response body of a failed HTTP check.
Get details for a single HTTP check result.
Get an HTTP monitor by ID.
Update an HTTP monitor.
Delete an HTTP monitor (and its paired TLS, DNS, and page-speed monitors).
List status-transition events for an HTTP monitor.
Get the latest page-speed scores for an HTTP monitor.
Get historical page-speed run results for an HTTP monitor.
Get aggregated response-time performance over a window for an HTTP monitor.
List the most recent HTTP check response times for a monitor.
List the most recent HTTP check results for a monitor, including headers, response body, request/response metadata, and failure reason.
Export a monitor's check results as CSV (chronological). Columns: timestamp, region, status, http_code, total_ms, dns_ms, tcp_connect_ms, tls_ms, ttfb_ms, download_ms, failure_reason.
Get the uptime percentage for an HTTP monitor.
List HTTP monitors for the authenticated account.
Create HTTP monitors from a CSV. Each row goes through `POST /http/job` so EventBridge schedules are attached.
List distinct HTTP monitor tags for the authenticated account.
TLS Monitors
Overview
Get a TLS monitor.
Get the most recent TLS check result.
DNS Monitors
Overview
Get a DNS monitor.
Set or clear the renewal date for a domain monitor.
Get the most recent DNS check result.
Create a DNS record monitor.
Read one DNS record monitor.
Edit a DNS record monitor.
Delete a DNS record monitor, its baselines and its history.
Accept one or more observed changes as the new baseline.
Pin an RRset to values the customer DECLARES rather than to values we observed.
The monitor's current baselines, one per watched RRset.
The monitor's check history, newest first.
List every DNS record monitor on the account.
Heartbeat Monitors
Overview
Create a heartbeat (cron) monitor.
Get a heartbeat (cron) monitor by ID.
Update a heartbeat (cron) monitor.
Delete a heartbeat (cron) monitor.
List status-transition events for a heartbeat (cron) monitor.
List recently received heartbeats for a cron monitor.
Get the uptime percentage for a heartbeat (cron) monitor.
List heartbeat monitors for the authenticated account.
Browser Monitors
Overview
List browser monitors for the authenticated account.
Create a synthetic browser monitor.
Get a browser monitor by ID.
Update a browser monitor.
Delete a browser monitor.
List recent run results for a browser monitor.
Generate a pre-signed S3 URL for a browser run artifact (HAR or video).
Trigger an immediate run of a browser monitor across its configured regions.
Get trending Web Vitals for a browser monitor.
Monitors Overview
Overview
One filtered, sorted, paged view of every monitor on the account: HTTP checks, heartbeats and browser checks together.
List prioritized attention items for the dashboard: unresolved incidents, down monitors, expiring TLS certificates and domains, and monitors trending slow.
List both HTTP and heartbeat monitors for the authenticated account.
Response-time samples for a whole page of monitors, keyed by monitor id.
Get account-wide HTTP response-time aggregates (avg + p95) for the last 24 hours in 15-minute buckets, feeding the dashboard trends chart.
Get aggregate counts of monitors and their statuses for the account, plus 24h uptime and response-time aggregates with previous-24h values for trend deltas.
Notifications
Overview
Create a notification destination (email/sms/slack/webhook/etc) within a notification group.
Get a notification destination by ID.
Update a notification destination.
Delete a notification destination.
List notification groups (with their notifications) for the account.
Create a notification group.
Get a notification group by ID.
Update a notification group.
Delete a notification group.
API Keys
Overview
List API keys for the authenticated account.
Create a new API key for the authenticated account.
Revoke an API key.
Rotate an API key: mint a replacement and revoke the predecessor, in one transaction.
M2M API Clients
Overview
OAuth2 authorization server metadata (RFC 8414).
List the account's active M2M API clients. Secrets are never included; they are only shown at create/rotate time.
Create an M2M API client. The response contains the full client secret. This is the ONLY time it is ever shown; it is not stored anywhere.
Revoke an M2M API client. The local row is revoked FIRST (that is what cuts access, because the auth middleware rejects tokens for revoked rows immediately), then the Stytch client is deleted best-effort. A Stytch cleanup failure is logged at ERROR (routed to the internal error notifier) but does not fail the request: access is already cut.
Rotate an M2M client's secret. Runs Stytch's start + complete in one call: the old secret stops validating immediately and the new one is returned exactly once. If completing fails after start, the rotation is cancelled best-effort so the old secret keeps working and the client can retry.
Exchange M2M client credentials for an access token (RFC 6749 section 4.4).
Audit Log
Overview
Customer-facing audit log: every mutating API request on the account with its actor (user session, M2M client, API key, or impersonating staff), newest first. Reads are capped to the last 90 days. Super admin, admin, or auditor role required, since the log exposes other members' actions and request IPs; audit read is the whole point of the auditor role (Datadog's Audit Trail Read is the precedent).
SLA Reports
Overview
Monthly SLA attainment for one HTTP monitor: uptime (from the daily performance rollup) vs the monitor's SLA target. The target comes from the monitor's status-page links when configured (strictest wins), else defaults to 99.9. The current month is partial; a month with no check data has `attained = null`.
Account-wide monthly SLA report: every HTTP monitor with its attainment per calendar month and breach flags. Targets come from status-page links where configured (strictest wins), else the 99.9 default.
Security
Overview
Get the authenticated member's available sign-in methods.
Finish attaching Google after the Stytch redirect, bound to the current session.
Start attaching Google OAuth to the currently signed-in member.
Disconnect an OAuth provider from the authenticated member.
Complete a passkey registration.
Begin a passkey registration. Returns the WebAuthn creation-options blob.
Delete a passkey by id.
Remove the member's password. Magic-link auth is always available, so the account never becomes locked out from this. We still verify the authenticated session before proceeding.
Change a password. Verifies the current password before applying the new one.
Set a password on an account that doesn't have one yet (magic-link / OAuth signups).
Disable TOTP for the authenticated member.
Verify a TOTP code and complete enrollment.
Begin TOTP enrollment. Returns the otpauth:// URL, secret, and recovery codes.
Incidents
Overview
List standalone (non-status-page) incidents for the account.
Create an incident.
One-click incident acknowledge/resolve via a signed link from email, SMS, or webhook payloads. Unauthenticated: the HMAC token is the credential.
Get a standalone (non-status-page) incident.
Update a standalone (non-status-page) incident.
Delete a standalone (non-status-page) incident.
Acknowledge an incident (responder takes ownership).
Publish an incident to a status page.
Mark an incident as resolved.
Add an incident-update message to a standalone incident.
List incidents for a status page.
Get an incident scoped to a status page.
Update an incident scoped to a status page.
Delete an incident scoped to a status page.
Add an incident-update message to an existing incident.
Status Pages
Overview
List status pages for the account.
Create a new status page.
Update a status page.
Delete a status page.
Get branding configuration for a status page.
Update branding configuration for a status page.
Delete a branding asset (logo, favicon, or og-image) from a status page.
Generate a pre-signed S3 URL for uploading a branding asset (logo, favicon, og-image).
List browser monitors attached to a status page.
Update a browser-monitor mapping on a status page.
Attach a browser monitor to a status page.
Detach a browser monitor from a status page.
Get the custom domain configuration for a status page.
Provision a custom domain for a status page.
Remove the custom domain configuration for a status page.
List HTTP monitors attached to a status page.
Update an HTTP-monitor mapping on a status page.
Attach an HTTP monitor to a status page.
Detach an HTTP monitor from a status page.
List maintenance windows for a status page.
Schedule a maintenance window on a status page.
Update a maintenance window on a status page.
Delete a maintenance window on a status page.
Escalation Policies
Overview
List escalation policies for the account.
Create an escalation policy.
Get an escalation policy by ID.
Update an escalation policy.
Delete an escalation policy.
List the levels of an escalation policy in order.
Add a level to an escalation policy.
Reorder the levels of an escalation policy.
Delete a level from an escalation policy.
On-Call Schedules
Overview
List on-call schedules for the account.
Create an on-call schedule.
Get an on-call schedule by ID.
Update an on-call schedule.
Delete an on-call schedule.
List the layers of an on-call schedule.
Add a layer to an on-call schedule.
Delete a layer from an on-call schedule.
List on-call overrides for a schedule.
Create an on-call override (one-off coverage swap).
Delete an on-call override.
Services
Overview
List services for the account.
Create a service.
Get a service by ID.
Update a service.
Delete a service.
List the monitors associated with a service.
Update the set of monitors associated with a service.
List notification targets attached to a service.
Add a notification target to a service.
Remove a notification target from a service.
User Contact Methods
Overview
List contact methods for a user.
Add a contact method (email, sms, slack DM, etc.) for a user.
Delete a contact method.
User Notification Rules
Overview
List notification rules for a user.
Create a notification rule for a user.
Update a notification rule.
Delete a notification rule.
Integrations
Overview
List third-party integrations for the account.
Add a Discord webhook integration.
Add a Google Chat webhook integration.
Add a Mattermost webhook integration.
Add a Microsoft Teams webhook integration.
Add an OpsGenie integration (Alerts API key).
Add a PagerDuty integration (Events API v2 routing key).
Add a Pushbullet integration (access token).
Add a Pushover integration (user key + app token).
Add a Slack integration via OAuth code exchange.
Complete a Telegram integration setup using the setup code from /integration/telegram/start.
Poll the Telegram integration setup state by setup code.
Begin Telegram integration setup. Issues a one-time setup code the user enters into the bot.
Add a generic webhook integration.
Update an integration's friendly name.
Delete an integration.
Maintenance Windows
Overview
List monitor maintenance windows for the account.
Create a maintenance window that suppresses alerts for matching monitors.
Update a maintenance window.
Delete a maintenance window.
Dashboards
Overview
List dashboards for the account.
Create a dashboard.
Get a dashboard by ID with widgets.
Update a dashboard's metadata.
Delete a dashboard.
Batch-update widget layout positions on a dashboard.
Add a widget to a dashboard.
Update a widget on a dashboard.
Delete a widget from a dashboard.
Logs
Overview
Get analytics aggregations for the logs dashboard: volume by source, top hosts by errors, volume by level, error rate by hour of day, and volume over time stacked by level.
Export log query results as CSV using the exact same filters as `GET /logs/query` (start_time, end_time, level, source, env, host, search, metadata_search, tags, excluded). `limit`/`offset` are ignored: the export returns the whole filtered set up to the cap, and refuses with a 400 when the set is larger.
Get facet value distributions for the active log query window.
Describe the fields available for log search and filtering.
Get auto-generated log-pattern insights (error spikes, new errors, silent sources).
Get recurring log patterns, clustered by normalised message template.
Query logs from ClickHouse with full-text search and filters.
List the distinct log sources for the account.
Aggregate log counts by level and source for a time window.
Long-poll tail of incoming logs since a cursor.
Get a histogram of log counts over time, bucketed for charting.
Log Parsers
Overview
List log parsers for the account.
Create a log parser.
Test a log parser configuration against a sample log line.
Get a log parser by ID.
Update a log parser.
Delete a log parser.
Log Saved Views
Overview
List saved log views for the user/account.
Create a saved log view.
Get a saved log view by ID.
Update a saved log view.
Delete a saved log view.
Metric Saved Views
Overview
List saved metric views for the user/account.
Create a saved metric view.
Get a saved metric view by ID.
Update a saved metric view.
Delete a saved metric view.
Metrics
Overview
Query histogram metric data: percentile time series plus the raw bucket matrix for heatmap rendering.
List metric names for the account.
Query metric series with aggregation, group-by, and time bucketing.
List the distinct metric sources.
Get a numeric summary (min/max/p50/p95/p99) for a metric over a window.
List the distinct tag keys for a metric.
List the distinct tag values for a metric+key pair.
Traces
Overview
List operation names for a given service.
Search distributed traces with filters.
Service-to-service call graph derived from traces.
List service names that have emitted traces in a window.
Time-bucketed trace volume for charting.
Get all spans for a single trace.
Get logs correlated to a trace ID.
RUM Applications
Overview
List RUM applications for the account.
Create a RUM application (issues a new SDK token).
Get a RUM application by ID.
Update a RUM application.
Delete a RUM application (revokes its SDK token).
Get the JS SDK configuration snippet for a RUM application.
List session filters for a RUM application.
Create a session filter on a RUM application.
Update a RUM session filter.
Delete a RUM session filter.
Rotate the SDK ingestion token for a RUM application.
RUM Source Maps
Overview
List source-map releases for a RUM application.
Create a source-map release record.
Delete a source-map release.
Generate a pre-signed S3 URL for uploading a source map for a release.
RUM Analytics
Overview
List grouped RUM errors (by fingerprint) for an application.
Get the symbolicated stack trace and occurrences for a single RUM error fingerprint.
Get RUM overview metrics for an application within a time window.
Get pre-signed S3 URLs for the session-replay segments of a RUM session.
List user sessions for a RUM application.
Get full event timeline for a single RUM session.
Get a Web Vitals time series for an application.
SSO
Overview
Get the account's SAML SSO connection, enriched with the live Stytch object so the UI can display the ACS URL / audience URI the customer needs at their IdP and the currently configured IdP values.
Update the account's SAML SSO connection. The IdP side can be configured either from a metadata URL (Stytch fetches entity id, SSO URL, and certificate) or field by field; supplying both applies the metadata URL first and then the explicit fields.
Create the account's SAML SSO connection. The response carries the service-provider values (ACS URL, audience URI) the customer configures at their IdP; the connection stays `pending` until the IdP side is filled in via the update endpoint.
Delete the account's SAML SSO connection. The local row goes first so the public SSO-start lookup stops resolving immediately even if the Stytch call fails; the Stytch delete is then best-effort.
SCIM
Overview
Get the account's SCIM connection. Never carries the bearer token, only its last four characters.
Create the account's SCIM connection. The response carries the SCIM base URL and the bearer token; the token is shown ONCE and is never stored or retrievable again, only rotated.
Delete the account's SCIM connection. Stytch goes first here (unlike the SSO delete): while the Stytch connection exists the IdP can still push directory changes, and killing that is the point of the operation. The local row is removed either way so the dashboard reflects reality.
Rotate the SCIM bearer token. Runs Stytch's start + complete in one call (same shape as the M2M secret rotation): the old token stops working immediately and the new one is returned exactly once. If completing fails after start, the rotation is cancelled best-effort so the IdP keeps syncing with its current token.
Partner
Overview
List the calling partner's managed client accounts.
Create a managed client account under the calling partner.
Soft-delete one of the caller's client accounts.
Set one of the caller's client accounts to a named entitlement bundle.
Per-product usage counters for one of the caller's client accounts.
Account
Returns the authenticated user's email-verification + MFA state from Stytch.
Re-send the invite email for a pending invite.
Set a team member's role.
Alert Rules
list_alert_rules
create_alert_rule
get_alert_rule
update_alert_rule
delete_alert_rule
test_alert_rule
Authentication
Re-send the email verification magic link to the authenticated user.
Complete a magic link authentication. If the email belongs to an existing account, signs the user in. Otherwise provisions a new SiteQwality account, Stytch organization, Stripe customer, default notification group, and welcome email. This is the same shape as `/signup` minus the password.
Send a discovery magic link to the given email. Works for both existing users (signs them in) and new users (provisioning happens on click via `/auth/magic-link/authenticate`).
Look up which authentication methods exist for an email. The response shape is constant-time-ish: we always return 200 with the same body shape regardless of whether the email exists, to slow account enumeration.
Resolve an email address to its account's SSO start URL, if that domain has an active SAML connection. Always 200; `redirect_url` is null when there is nothing to start.
Complete an SSO login: exchange the `token` Stytch appended to the login redirect (`stytch_token_type=sso`) for a session.
Billing
Buy an add-on, or move between tiers of one.
Remove an add-on.
Schedule cancellation at the end of the current period.
Undo a scheduled cancellation.
Change subscription plan/quantity for a product.
Preview the cost and consequences of a plan change.
Stripe publishable key for the Payment Element.
List all paid-plan features and whether the account has access to each.
Invoice history.
Pay an open invoice.
Current billing state.
List the cards on file.
Choose which card gets charged.
Start adding a card.
Remove a card.
List all active billing plans (public endpoint).
Get the account's purchased SMS credit balance and the packs on offer.
Buy a one-time SMS credit pack without leaving the app.
List active subscriptions for the account.
Get current billing-period usage counters by product.
Archived usage from closed billing periods.
Monitors
Export an uptime summary per HTTP monitor as CSV. Uptime is the average of daily uptime percentages from the daily performance rollup over the requested range (the same math the status page uses). Row count is bounded by the account's monitor count, so no row cap applies.
A branded uptime report for one calendar month, as a printable page.
Webhooks
Stytch webhook receiver: syncs IdP/SCIM directory changes into the local users table.
Select theme
Dark
Light
Auto
Overview
Partner
Section titled “Partner”
Manage client accounts as an agency or MSP partner
Operations
Section titled “ Operations ”
GET
/partner/accounts
POST
/partner/accounts
DELETE
/partner/accounts/{client_account_id}
PUT
/partner/accounts/{client_account_id}/plan
GET
/partner/accounts/{client_account_id}/usage
