Get Dashboard Objects By Region

POST 
/dlp/api/v1/dashboard/objects/aggregate/by-region

Lists regions with object counts and identifies object counts by classification. Data profiles determine classification.

Request

application/json; charset=UTF-8

Body

accountGroupIds string[]required

List of cloud account group ids

accountGroupNames string[]required

List of AWS account group names

accountIds string[]required

List of cloud account ids

classifications string[]required

List of Data classifications

limit int32required

Limit the records returned

timeRange objectrequired

See the Time Range Model for details.

oneOf

RelativeTimeRangeConfigModel

relativeTimeType string

Possible values: [BACKWARD, FORWARD]

Direction in which to count time. Default = BACKWARD

type string

value objectrequired

Model for RelativeTimeDuration

amount int32

Number of time units

unit string

Possible values: [minute, hour, day, week, month, year]

Time unit

AbsoluteTimeRangeConfigModel

type string

value objectrequired

Model for Time

endTime int64

End timestamp

startTime int64

Start timestamp

ToNowTimeRangeConfigModel

value string

Possible values: [MINUTE, HOUR, DAY, WEEK, MONTH, YEAR, EPOCH, LOGIN]

Time range object

type stringrequired

Possible values: [absolute, relative, to_now]

Time type

absolute

type string

value objectrequired

Model for Time

endTime int64

End timestamp

startTime int64

Start timestamp

relative

relativeTimeType string

Possible values: [BACKWARD, FORWARD]

Direction in which to count time. Default = BACKWARD

type string

value objectrequired

Model for RelativeTimeDuration

amount int32

Number of time units

unit string

Possible values: [minute, hour, day, week, month, year]

Time unit

to_now

value string

Possible values: [MINUTE, HOUR, DAY, WEEK, MONTH, YEAR, EPOCH, LOGIN]

Time range object

Responses

200

success

application/json; charset=UTF-8

Schema

Schema

• Array [
classification object[]
List of classification
Array [
count int32
Count
name string
Name
]
cloudType string

Cloud Type

latitude double

Latitude

longitude double

Longitude

regionCode string

Cloud region

regionName string

Cloud region name

• ]

Example (from schema)

[
  {
    "classification": [
      {
        "count": 0,
        "name": "string"
      }
    ],
    "cloudType": "string",
    "latitude": 0,
    "longitude": 0,
    "regionCode": "string",
    "regionName": "string"
  }
]

Loading...