The Stats API allows you to retrieve performance metrics, response time data, check logs, and incident duration statistics for a specific monitor over a designated date range.


1. Show Monitor Stats

Retrieves statistical time-series data for a specific monitor based on the selected metric type and timeframe.

HTTP Request

HTTP
GET https://veyon.app/api/v1/stats/{monitor_id}

Request Headers

HeaderTypeValueRequired
AuthorizationStringBearer {api_key}Yes
AcceptStringapplication/jsonYes

Query Parameters

ParameterTypeModeDescription
nameStringRequired

The metric type to query.


• check: Monitor check results.


• check_response_time: Response time metrics.


• incident: Incident count metrics.


• incident_duration: Total incident duration/downtime stats.

fromStringRequiredStarting date in Y-m-d format (e.g., 2026-07-01).
toStringRequiredEnding date in Y-m-d format (e.g., 2026-07-23).
sortStringoptional

Sort order for the returned time series.


• desc: Descending (default).


• asc: Ascending.

Request Example (cURL)

Bash
curl --location --request GET 'https://veyon.app/api/v1/stats/{monitor_id}?name={name}&from={from}&to={to}' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {api_key}'