Call reports

List call reports

get

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0

topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100

Responses

200

OK

application/json

4XX

Error

get

/call_reports

HTTPcURLJavaScriptPython

GET /api/call_reports HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "name": "text",
      "type": "NORMAL",
      "cron_expr": "text",
      "status": "RUNNING"
    }
  ]
}

Create new call report

post

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

namestringRequired

The name of call report.

typestring · enumRequired

The report types can be either:

• NORMAL:
• EXTENSION_GROUP_CALL_COST:
• QUEUE_PERFORMANCE:
• QUEUE_DETAILED_STATISTICS:
• QUEUE_ABANDONED_CALLS:
• QUEUE_SLA_STATISTICS:
• QUEUE_BREACHES_SLA_STATISTICS:
• QUEUE_CALLBACKS:
• QUEUE_FAILED_CALLBACKS:
• TEAM_QUEUE_GENERAL_STATISTICS:
• RING_GROUP_STATISTICS:

Possible values:

emailall ofRequired

The email address to which the report file will be sent after the report is complete.

string · max: 128Optional

The email address.

Example: [email protected]

formatstring · enumRequired

The report output files format can be either:

• CSV:
• HTML:

Possible values:

rangestring · enumRequired

The report range can be either:

• TODAY: the day the report was generated.
• YESTERDAY: yesterday of the day the report was generated.
• LAST_WEEK: the last week of the day the report was generated.
• LAST_SEVEN_DAYS: seven days before the day the report was generated.
• LAST_MONTH: the last month of the day the report was generated.
• LAST_THIRTY_DAYS: thirty days before the day the report was generated.
• CUSTOM: custom date range.

Possible values:

started_atall ofOptional

Filter data after specified data time.
Only valid when the range is specified as CUSTOM

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

ended_atall ofOptional

Filter data before specified data time.
Only valid when the range is specified as CUSTOM

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

cron_exprstringOptional

The crontab expression https://en.wikipedia.org/wiki/Cron

filterone ofRequired

or

or

or

or

or

or

or

or

or

or

or

Responses

201

Created

application/json

4XX

Error

post

/call_reports

HTTPcURLJavaScriptPython

POST /api/call_reports HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 326

{
  "name": "text",
  "type": "NORMAL",
  "email": "[email protected]",
  "format": "CSV",
  "range": "TODAY",
  "started_at": "2017-07-21T17:32:28Z",
  "ended_at": "2017-07-21T17:32:28Z",
  "cron_expr": "text",
  "filter": {
    "from": "ANY",
    "from_value": "text",
    "to": "ANY",
    "to_value": "text",
    "answer_state": "ANY",
    "duration": "ANY",
    "duration_from": 1,
    "duration_to": 1
  }
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Get call report details

get

Get details of call report by it's unique ID.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of this call report.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/call_reports/{id}

HTTPcURLJavaScriptPython

GET /api/call_reports/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "name": "text",
  "type": "NORMAL",
  "email": "[email protected]",
  "format": "CSV",
  "range": "TODAY",
  "started_at": "2017-07-21T17:32:28Z",
  "ended_at": "2017-07-21T17:32:28Z",
  "cron_expr": "text",
  "filter": {
    "from": "ANY",
    "from_value": "text",
    "to": "ANY",
    "to_value": "text",
    "answer_state": "ANY",
    "duration": "ANY",
    "duration_from": 1,
    "duration_to": 1
  },
  "status": "RUNNING"
}

Update call report

post

Update call report properties.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of this call report.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

application/json

namestringOptional

The name of call report.

emailall ofOptional

The email address to which the report file will be sent after the report is complete.

string · max: 128Optional

The email address.

Example: [email protected]

formatstring · enumOptional

The report output files format can be either:

• CSV:
• HTML:

Possible values:

rangestring · enumOptional

The report range can be either:

• TODAY: the day the report was generated.
• YESTERDAY: yesterday of the day the report was generated.
• LAST_WEEK: the last week of the day the report was generated.
• LAST_SEVEN_DAYS: seven days before the day the report was generated.
• LAST_MONTH: the last month of the day the report was generated.
• LAST_THIRTY_DAYS: thirty days before the day the report was generated.
• CUSTOM: custom date range.

Possible values:

started_atall ofOptional

Filter data after specified data time.
Only valid when the range is specified as CUSTOM

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

ended_atall ofOptional

Filter data before specified data time.
Only valid when the range is specified as CUSTOM

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

cron_exprstringOptional

The crontab expression https://en.wikipedia.org/wiki/Cron

filterone ofOptional

or

or

or

or

or

or

or

or

or

or

or

Responses

200

OK

No content

4XX

Error

post

/call_reports/{id}

HTTPcURLJavaScriptPython

POST /api/call_reports/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 310

{
  "name": "text",
  "email": "[email protected]",
  "format": "CSV",
  "range": "TODAY",
  "started_at": "2017-07-21T17:32:28Z",
  "ended_at": "2017-07-21T17:32:28Z",
  "cron_expr": "text",
  "filter": {
    "from": "ANY",
    "from_value": "text",
    "to": "ANY",
    "to_value": "text",
    "answer_state": "ANY",
    "duration": "ANY",
    "duration_from": 1,
    "duration_to": 1
  }
}

No content