v1

latestOpenAPI 3.1.02026-08-042010999.7 KB

Monitoring: History

Retrieve history events for all entities in a paginated stream

This endpoint will return a paginated list of all entities' history events. A history event is created whenever an entity's data changes for any reason. Only includes monitored, unarchived entities.

post/entities/histories

Query parameters

pageinteger

Page number, 1-indexed. Default: 1

Example:1

Page number, 1-indexed. Default: 1

pageSizeinteger

Number of results per page. Maximum: 100, Default: 10

Example:10

Number of results per page. Maximum: 100, Default: 10

{"stackTrail":"paths:/entities/histories:post:parameters:2:schema","oasType":"schema","type":"unknown","nullable":true}

Request body

{"stackTrail":"components:schemas:RequestEntitiesHistoriesRequestPublic:properties:cursor","oasType":"schema","type":"unknown"}

groupIDsinteger[] nullable

Optional. An array of group IDs to include entities from.

historyTypesstring[] nullable

Optional. An array of history types to include. Empty means all.

pageinteger

Page number, 1-indexed. Default: 1

pageSizeinteger

Number of results per page. Maximum: 100, Default: 10

totalinteger

Total number of results. Ignored in requests, used in responses.

Example request

{
  "createdAt": {
    "since": "2023-01-01T00:00:00Z",
    "until": "2023-01-01T00:00:00Z"
  },
  "page": 1,
  "pageSize": 10,
  "total": 15000
}

Response

pageinteger

pageSizeinteger

totalinteger