ZUzuper

Get Report Executions

Changed on
get/v3/reports/executions

Request

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

Query parameters

filter.keywordstring

Keyword search based on Report Execution name

filter.report_uidstring

Report uid

filter.status'Queued' | 'inprogress' | 'completed' | 'failed'

Execution status

filter.execution_typestring

Execution type

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": [
    {
      "execution_uid": "0607692e-d5b1-41a9-880e-90fb7b4c02eh",
      "report_name": "test Report - 1",
      "status": "Queued",
      "execution_type": "Manual",
      "created_at": "2024-04-09T07:46:00.000Z",
      "created_by": 1,
      "report.report_uid": "17397715-5c49-489d-a4db-69ac45a9179b",
      "report.report_name": "test Report - 1",
      "report.report_description": "Testing report",
      "report.created_by": 1,
      "created_by_user": {
        "user_uid": "cfa78be2-b427-4d5a-89fe-7cf4a8e01352",
        "first_name": "velmurugan",
        "last_name": "k",
        "email": "velmurugan.k@zuper.co",
        "home_phone_number": "9600086457",
        "designation": "Admin",
        "emp_code": "001",
        "work_phone_number": "9600086457",
        "hourly_labor_charge": 20,
        "is_active": 1,
        "created_at": "2022-11-03T11:33:22.000Z",
        "updated_at": "2023-10-10T13:38:04.000Z"
      }
    }
  ],
  "current_page_records": 1,
  "total_records": 1,
  "current_page": 1,
  "total_pages": 1,
  "type": "success"
}

Changes