Skip to main content

List generated reports​

Returns a list of unexpired, generated reports.

Query Parameters
  • 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
    FieldFilter ConditionDescription
    start_timestamp$gte, $ltStart timestamp denotes the time filter for listing CSV report downloads. $gte and $lt accept RFC-3339 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_v2", "audit", and "consumption". ?filter={"report_type":{"$in":["compliance"]}}

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

Success

Schema
  • _embedded object

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

  • items object[]

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

  • 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 when 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.

  • id string

    The id of the report that uniquely identifies the report.

  • start_timestamp string

    The time when 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.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • _last object

    The HATEOAS link to the last page of results.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • _next object

    The HATEOAS link to the next page of results.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • _prev object

    The HATEOAS link to the previous page of results.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • _self object

    The HATEOAS link to this resource.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

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

Loading...