Risk Posture
Enterprise

Get Posture Statistics

Changed on

Gets the history of database stats saved in the database

get/api/v2/posture-stats

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v2/posture-stats
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization and API key in header RequestDate and API key in header Signature

Query parameters

sort_bystring

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

Sortable columns are domain_sid, exposure_index, tier_zero_count, critical_risk_count, id, created_at, updated_at, deleted_at.

fromstring date-time

Lower bound for created_at; to return posture stats starting at a specific date/time. This filter has been deprecated, please use created_at instead.

tostring date-time

Upper bound for created_at; to return posture stats upto a specific date/time. This filter has been deprecated, please use created_at instead.

domain_sidstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

exposure_indexstring

Filter results by column integer value. Valid filter predicates are eq, neq, gt, gte, lt, lte.

asset_group_tag_idstring

Filter results by column integer value. Valid filter predicates are eq, neq, gt, gte, lt, lte.

tier_zero_countstring

Filter results by column integer value. Valid filter predicates are eq, neq, gt, gte, lt, lte.

critical_risk_countstring

Filter results by column integer value. Valid filter predicates are eq, neq, gt, gte, lt, lte.

idstring

Filter results by column integer value. Valid filter predicates are eq, neq, gt, gte, lt, lte.

created_atstring

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

updated_atstring

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

deleted_atstring

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

Response

OK

countinteger

The total number of results.

skipinteger

The number of items to skip in a paginated response.

limitinteger

The limit of results requested by the client.

startstring date-time

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

endstring date-time

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

Changes

  • 40bf219eced6Revision changes
    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?-?[0-9]+$ to the query request parameter asset_group_tag_id

    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?-?[0-9]+$ to the query request parameter critical_risk_count

    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?-?[0-9]+$ to the query request parameter exposure_index

    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?-?[0-9]+$ to the query request parameter id

    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?-?[0-9]+$ to the query request parameter tier_zero_count

    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter created_at

    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter deleted_at

    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter updated_at

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter domain_sid

    • info

      for the query request parameter asset_group_tag_id, the type was generalized from integer to string

    • info

      for the query request parameter created_at, the format was generalized from date-time to no format

    • info

      for the query request parameter critical_risk_count, the type was generalized from integer to string

    • info

      for the query request parameter deleted_at, the format was generalized from date-time to no format

    • info

      for the query request parameter exposure_index, the type was generalized from integer to string

    • info

      for the query request parameter id, the type was generalized from integer to string

    • info

      for the query request parameter tier_zero_count, the type was generalized from integer to string

    • info

      for the query request parameter updated_at, the format was generalized from date-time to no format

  • 6aaeba6ecdc5Revision changes
    • breaking

      for the query request parameter asset_group_tag_id, the type changed from string to integer

    • breaking

      for the query request parameter created_at, the format changed from no format to date-time

    • breaking

      for the query request parameter critical_risk_count, the type changed from string to integer

    • breaking

      for the query request parameter deleted_at, the format changed from no format to date-time

    • breaking

      for the query request parameter exposure_index, the type changed from string to integer

    • breaking

      for the query request parameter id, the type changed from string to integer

    • breaking

      for the query request parameter tier_zero_count, the type changed from string to integer

    • breaking

      for the query request parameter updated_at, the format changed from no format to date-time

    • info

      removed the pattern ^((eq|neq|gt|gte|lt|lte):)?-?[0-9]+$ from the query request parameter asset_group_tag_id

    • info

      removed the pattern ^((eq|neq|gt|gte|lt|lte):)?-?[0-9]+$ from the query request parameter critical_risk_count

    • info

      removed the pattern ^((eq|neq|gt|gte|lt|lte):)?-?[0-9]+$ from the query request parameter exposure_index

    • info

      removed the pattern ^((eq|neq|gt|gte|lt|lte):)?-?[0-9]+$ from the query request parameter id

    • info

      removed the pattern ^((eq|neq|gt|gte|lt|lte):)?-?[0-9]+$ from the query request parameter tier_zero_count

    • info

      removed the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ from the query request parameter created_at

    • info

      removed the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ from the query request parameter deleted_at

    • info

      removed the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ from the query request parameter updated_at

    • info

      removed the pattern ^((eq|~eq|neq):)?[^:]+$ from the query request parameter domain_sid