Skip to main content
GET
/
api
/
v2
/
posture-history
/
{data_type}
{
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "environments": [
    "<string>"
  ],
  "data_type": "findings",
  "data": [
    {
      "date": "2023-11-07T05:31:56Z",
      "value": 123
    }
  ]
}
Applies to BloodHound Enterprise only

Authorizations

​
Authorization
string
header
required

Authorization: Bearer $JWT_TOKEN

Headers

​
Prefer
integer
default:0

Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240.

Required range: x >= 0

Path Parameters

​
data_type
enum<string>
required

The type of posture data to return

Available options:
findings,
exposure,
assets,
session-completeness,
group-completeness,
attack-paths

Query Parameters

​
asset_group_tag_id
integer

The asset group tag id of the zone requested. If not supplied, the asset group tag id associated with 'Tier Zero' is used.

​
environments
string[]
required

Environment IDs

​
start
string<date-time>

Beginning datetime of range (inclusive) in RFC-3339 format; Defaults to current datetime minus 30 days

​
end
string<date-time>

Ending datetime of range (exclusive) in RFC-3339 format; Defaults to current datetime

Response

OK

​
start
string<date-time>

The RFC-3339 timestamp to describe the beginning of a time range

​
end
string<date-time>

The RFC-3339 timestamp to describe the end of a time range

​
environments
string[]
​
data_type
enum<string>

This enum describes the valid data types for posture history results.

Available options:
findings,
exposure,
assets,
session-completeness,
group-completeness,
attack-paths
​
data
object[]
⌘I