Attack Paths
Enterprise

List attack path sparkline values

Changed on

List the values that represent the sparklines for individual attack paths

get/api/v2/domains/{domain_id}/sparkline

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v2/domains/{domain_id}/sparkline
  • 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 CompositeRisk, FindingCount, ImpactedAssetCount, domain_sid, id, created_at, and updated_at.

findingstring required

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

fromstring

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

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

tostring

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

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

Response

OK

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]{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 from

    • 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 to

    • breaking

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

    • info

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

    • info

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

  • 6aaeba6ecdc5Revision changes
    • breaking

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

    • breaking

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

    • 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 from

    • 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 to

    • info

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