Skip to main content
GET
Get platform data quality aggregate
Applies to BloodHound Enterprise and CE

Authorizations

Authorization
string
header
required

Authorization: Bearer $JWT_TOKEN

Headers

Prefer
string
default:wait=30

Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. Passing in wait=-1 bypasses all timeout limits when the feature is enabled.

Pattern: ^wait=(-1|[0-9]+)$

Path Parameters

platform_id
enum<string>
required

Platform ID

Available options:
ad,
azure

Query Parameters

sort_by
string

Sortable columns are created_at, updated_at. Sort by column. Can be used multiple times; prepend a hyphen for descending order. See parameter description for details about which columns are sortable.

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

skip
integer

This query parameter is used for determining the number of objects to skip in pagination. The number of items to skip in a paginated response.

Required range: x >= 0
limit
integer

This query parameter is used for setting an upper limit of objects returned in paginated responses. The limit of results requested by the client.

Required range: x >= 0

Response

OK

count
integer

The total number of results.

Required range: x >= 0
skip
integer

The number of items to skip in a paginated response.

Required range: x >= 0
limit
integer

The limit of results requested by the client.

Required range: x >= 0
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

data
object[]