v1

latestOpenAPI 3.0.32026-07-14490228.1 KB

Create Report

This endpoint creates a new report and associates it with the client.

post/reports

Request body

namestring required

The name used to easily identify the report. Allowed values are between 2 and 255 characters.

typestring required

The type of report. Allowed values are call_summary, rep_summary, call_export, segment_person_export.

Response

201

idinteger

namestring

typestring

statusstring

Example response

{
  "id": 1,
  "name": "Test Report 1",
  "type": "call_summary",
  "params": {
    "date_end": "2021-07-10",
    "group_by": "day",
    "date_start": "2021-06-10"
  },
  "schedule": {
    "run_at": "2021-07-10 20:34:21"
  },
  "status": "scheduled"
}