Skip to main content

Get Object Counts by Classification

POST 
/dlp/api/v1/inventory/objects/aggregate/by-classification

Returns the object counts identified by classification, malware, and object exposure.

Request​

Body

    detailed boolean

    Detailed

    fields string[]

    Array of specific fields to return

    filters object[]

    Filtering parameters.

    For filter names, refer to List Filters API.

    For filter values, refer to List filter suggestions.

    The only exception is resource.tagv2 filter name, provide filter value for it in the following format: "{"key":"'CustomerTagKey'","value":"'CustomerTagValue'"}"

  • Array [
    • name string

    Name

    operator string

    Possible values: [tag:yaml.org,2002:value =]

    Operator

    value string

    Value

  • ]
    • groupBy string[]

    For asset or data inventory only. Group returned items by cloud.type, cloud.service, cloud.region, cloud.account, and/or resource.type

    limit number

    Maximum number of items to return. When data is paginated, maximum number of items per page.The maximum cannot exceed 10,000. The default is 10,000.

    offset number

    The number of items to skip before selecting items to return. Default is zero

    pageToken string

    Setting this pagination Token to the nextPageToken from a response object returns the next page of data

    sortBy string[]

    Array of sort properties. Append :asc or :desc to the key to sort by ascending or descending order respectively. Example sort properties are id:asc and timestamp:desc

    tableLevel int32required

    Possible values: [1, 2, 3]

    Table level

    timeRange object

    See the Time Range Model for details.

    oneOf
    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

    type stringrequired

    Possible values: [absolute, relative, to_now]

    Time type

    type string
    value objectrequired

    Model for Time

    endTime int64

    End timestamp

    startTime int64

    Start timestamp

Responses​

success

Schema
  • Array [
    • classification string

    Object classification

    count int32

    Object count

    exposure string

    Object Exposure

    severity string

    Policy Severity

  • ]
Loading...