ZUzuper

Get Report Folders

Changed on
get/v3/reports/folders

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/v3/reports/folders
  • Auth
    API key in header x-api-key

Query parameters

filter.keywordstring

Keyword search based on Folder name

filter.from_datestring date

Created Date From

filter.to_datestring date

Created Date To

pageinteger

Page to fetch

countinteger

Number of Reports in the page

sort'DESC' | 'ASC'

Sort order

sort_by'report_name' | 'created_at' | 'updated_at'

Sort type

Response

200

current_page_recordsinteger
total_recordsinteger
current_pageinteger
total_pagesinteger
typestring

Example response

{
  "data": [
    {
      "folder_uid": "e2338165-0817-4c58-8894-62a436cf4460",
      "folder_name": "test_Report_folder-2",
      "report_count": 1,
      "created_at": "2024-04-09T10:08:42.000Z",
      "updated_at": "2024-04-09T10:08:42.000Z"
    }
  ],
  "current_page_records": 2,
  "total_records": 2,
  "current_page": 1,
  "total_pages": 1,
  "type": "success"
}

Changes