Get overview metrics
Returns aggregate stats for today — queries raw tables directly for instant accuracy.
GET
/metrics/overview
Returns aggregate stats for today — queries raw tables directly for instant accuracy.
Authentication
API Key (header: X-API-Key) API Key (cookie: better-auth.session_token)
Responses
200
Overview metrics
application/jsonevents_today
number
REQUIRED
events_this_week
number
REQUIRED
active_sources
number
REQUIRED
deliveries_today
number
REQUIRED
success_today
number
REQUIRED
failed_today
number
REQUIRED
success_rate_today
number
REQUIRED
dlq_count
number
REQUIRED
active_destinations
number
REQUIRED
open_issues
number
REQUIRED
active_collections
number
REQUIRED
401
Unauthorized
curl -X GET 'https://hookstream.io/v1/metrics/overview' \
-H 'Authorization: Bearer YOUR_API_TOKEN'
const response = await fetch('https://hookstream.io/v1/metrics/overview', {
method: 'GET',
headers: {
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer YOUR_API_TOKEN'
}
response = requests.get('https://hookstream.io/v1/metrics/overview', headers=headers)
print(response.json())
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://hookstream.io/v1/metrics/overview", nil)
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
result, _ := io.ReadAll(resp.Body)
fmt.Println(string(result))
}
200
Response
{
"events_today": 123,
"events_this_week": 123,
"active_sources": 123,
"deliveries_today": 123,
"success_today": 123,
"failed_today": 123,
"success_rate_today": 123,
"dlq_count": 123,
"active_destinations": 123,
"open_issues": 123,
"active_collections": 123
}
GET
/metrics/overview