Statistics

Statistics of usage

List scan statistics

get/statistics/scans

List scan statistics.

Request
query Parameters
cursor
string <byte>

An encoded value used to retrieve the next set of results for a query that returns more than limit results.

from
required
string

The start time of the statistics in the format of RFC3339 timestamps. Will be rounded down according to interval parameter.

Example: from=2021-01-01T10:00:00Z
interval
required
string

The aggregation interval of each data point.

Enum: "1h" "1d"
limit
integer <= 30
Default: 30

The maximum number of records to return.

provider
string

Cloud provider. If this parameter is not provided, the query will return scan statistics for all cloud providers.

Enum: "aws" "azure" "gcp"
storage
string

Cloud storage. If this parameter is not provided, the query will return scan statistics for all cloud storages.

to
required
string

The end time of the statistics in the format of RFC3339 timestamps. Will be rounded down according to interval parameter.

Example: to=2021-01-02T10:00:00Z
header Parameters
Api-Version
required
any

API version.

Example: v1
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Response samples
application/json
{
  • "statistics": [
    ],
  • "next": "dGhpcyB2YWx1ZSBpcyBvcGFxdWUsIGRlY29kaW5nIGl0IHdvbid0IGJlIHVzZWZ1bAo="
}