Skip to main content
GET
/
v1
/
analytics
/
alerts
Alert statistics
curl --request GET \
  --url https://instance.prod.onboardapp.io/v1/analytics/alerts \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://instance.prod.onboardapp.io/v1/analytics/alerts"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://instance.prod.onboardapp.io/v1/analytics/alerts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://instance.prod.onboardapp.io/v1/analytics/alerts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://instance.prod.onboardapp.io/v1/analytics/alerts"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-KEY", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://instance.prod.onboardapp.io/v1/analytics/alerts")
.header("X-API-KEY", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://instance.prod.onboardapp.io/v1/analytics/alerts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "data": {
    "total": 123,
    "resolved": 123,
    "false_positives": 123,
    "escalated": 123,
    "resolution_rate": 123,
    "false_positive_rate": 123,
    "average_resolution_hours": 123,
    "breakdown": [
      {
        "label": "<string>",
        "count": 123,
        "percentage": 123
      }
    ],
    "period": {
      "from": "2023-11-07T05:31:56Z",
      "to": "2023-11-07T05:31:56Z"
    }
  },
  "meta": {
    "request_id": "req_9k4m2n1p3q",
    "page": {
      "cursor": "<string>",
      "has_more": true
    }
  }
}
{
"error": {
"message": "<string>",
"request_id": "req_9k4m2n1p3q",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}
}
{
"error": {
"message": "<string>",
"request_id": "req_9k4m2n1p3q",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}
}
{
"error": {
"message": "<string>",
"request_id": "req_9k4m2n1p3q",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}
}

Authorizations

X-API-KEY
string
header
required

Project-scoped API key for server-to-server authentication. Obtain keys from the Zenoo dashboard under Project Settings > API Keys. Staging and production environments use separate keys.

Query Parameters

from
string<date-time>

Start date (ISO 8601).

to
string<date-time>

End date (ISO 8601).

group_by
enum<string>
default:category

Group results by dimension.

Available options:
category,
type,
priority,
status

Response

Alert statistics.

Standard response wrapper for all API endpoints. Contains the resource data and pagination metadata.

data
object

Alert-specific statistics and trends.

meta
object