List generated reports

get https://{region}.api.clumio.com/reports/downloads

Returns a list of unexpired, generated reports.

time	status	user agent
Retrieving recent requests…

Loading…

Query Params

limit

int64

Limits the size of the response on each page to the specified number of items.

start

string

Sets the page number used to browse the collection. Pages are indexed starting from 1 (i.e., ?start=1).

filter

string

Field	Filter Condition	Description
start_timestamp	$gte, $lt	Start timestamp denotes the time filter for listing CSV report downloads.v$gte and $lt accept RFC-3999 timestamps. For example,`"filter":"{"start_timestamp":{"$gt":"2019-10-12T07:20:50.52Z"}}"`
report_type	$in	Filter report downloaded records whose type is one of the given values. The possible values are: "activity", "compliance", "audit", and "consumption".`?filter={"report_type":{"$in":["compliance"]}}`

For more information about filtering, refer to the Filtering section of this guide.

Responses

Response body

object

_embedded

object

_embedded contains the list of items of a list report CSV download query

items

array of objects

items denotes the list of CSV downloads in the current scope.

items

object

download_link

string

The link to the actual CSV report.

end_timestamp

string

The time when the request was completed.

expiration_timestamp

string

The time this report CSV will expire and not be available for download.

file_name

string

The name of CSV file.

filters

string

The filters applied to the report when download was initiated.

string

The ID of the report that uniquely identifies the report.

start_timestamp

string

The time the request was made.

task_id

string

The Clumio-assigned ID of the task which generated the restored file.

type

string

The type of report this CSV Download is associated with. The possible values include "activity" and "compliance".

_links

object

_links provides URLs to related navigable pages of a list report CSV download query

_first

object

The HATEOAS link to the first page of results.

_last

object

The HATEOAS link to the last page of results.

_next

object

The HATEOAS link to the next page of results.

_prev

object

The HATEOAS link to the previous page of results.

_self

object

The HATEOAS link to this resource.

current_count

int64

The number of items listed on the current page.

filter_applied

string

The filter used in the request. The filter includes both manually-specified and system-generated filters.

limit

int64

The maximum number of items displayed per page in the response.

start

string

The page number used to get this response. Pages are indexed starting from 1 (i.e., "start": "1").

total_count

int64

The total number of items, summed across all pages.

total_pages_count

int64

The total number of pages of results.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://us-west-2.api.clumio.com/reports/downloads \
3
     --header 'accept: application/api.clumio.report-downloads=v1+json'


xxxxxxxxxx
50
}
1
{
2
  "_embedded": {
3
    "items": [
4
      {
5
        "download_link": "string",
6
        "end_timestamp": "string",
7
        "expiration_timestamp": "string",
8
        "file_name": "string",
9
        "filters": "string",
10
        "id": "string",
11
        "start_timestamp": "string",
12
        "task_id": "string",
13
        "type": "string"
14
      }
15
    ]
16
  },
17
  "_links": {
18
    "_first": {
19
      "href": "string",
20
      "templated": true,
21
      "type": "string"
22
    },
23
    "_last": {
24
      "href": "string",
25
      "templated": true,

200200 HTTP success response

defaultError