Skip to content
BleemeoBleemeo

Retrieve a yearly recap

GET
/v1/yearlyrecap/{id}/
curl --request GET \
--url https://example.com/v1/yearlyrecap/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/ \
--header 'Authorization: Bearer <token>'

Return a single yearly recap data point by its ID.

id
required
string format: uuid

A UUID string identifying this yearly recap data point.

Media typeapplication/json

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

object
id
required
string format: uuid
period_start
required

Start date is included

string format: date-time
period_end
required

End date is excluded

string format: date-time
number_of_incidents
integer
>= -2147483648 <= 2147483647
most_recurring_alerts
nullable
most_affected_services
nullable
most_affected_monitors
nullable
day_with_most_alerts
nullable
month_with_most_alerts
nullable
notifications_per_integration
nullable
number_of_agents_created
nullable
monitor_uptimes
nullable
favourite_os
nullable
server_locations
nullable
month_incidents
nullable
Examplegenerated
{
"period_start": "2026-04-15T12:00:00Z",
"period_end": "2026-04-15T12:00:00Z",
"number_of_incidents": 1,
"most_recurring_alerts": "example",
"most_affected_services": "example",
"most_affected_monitors": "example",
"day_with_most_alerts": "example",
"month_with_most_alerts": "example",
"notifications_per_integration": "example",
"number_of_agents_created": "example",
"monitor_uptimes": "example",
"favourite_os": "example",
"server_locations": "example",
"month_incidents": "example"
}