List yearly recaps

GET

/v1/yearlyrecap/

const url = 'https://example.com/v1/yearlyrecap/';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/yearlyrecap/ \
  --header 'Authorization: Bearer <token>'

Return all yearly recap data points for the current account.

Authorizations

jwtAuth
basicAuth

Parameters

Query Parameters

cursor

string

The pagination cursor value.

page_size

integer

Number of results to return per page.

search

string

A search term.

Responses

200

application/json

object

next

string format: uri

nullable

previous

string format: uri

nullable

results

required

Array<object>

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

object

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

Example

{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"
}