Call reports

List call reports

get

Authorizations

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 · int32 · default: 0optional

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

topinteger · int32 · min: 1 · max: 100 · default: 100optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/call_reports' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

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

OK

Create new call report

post

Authorizations

Body

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:

Available options:

emailall ofrequired

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

The email address.

formatstring · enumrequired

The report output files format can be either:

• CSV:
• HTML:

Available options:

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.

Available options:

started_atall ofoptional

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

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

ended_atall ofoptional

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

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

cron_exprstringoptional

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

filterone ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/call_reports' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "type": "NORMAL",
    "email": "[e-mail]",
    "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
    }
  }'

201

4XX

201

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created

Get call report details

get

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

Authorizations

Path parameters

idall ofrequired

The unique ID of this call report.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/call_reports/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "name": "text",
  "type": "NORMAL",
  "email": "[e-mail]",
  "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"
}

OK

Update call report

post

Update call report properties.

Authorizations

Path parameters

idall ofrequired

The unique ID of this call report.

The unique ID of the resource.

Body

namestringoptional

The name of call report.

emailall ofoptional

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

The email address.

formatstring · enumoptional

The report output files format can be either:

• CSV:
• HTML:

Available options:

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.

Available options:

started_atall ofoptional

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

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

ended_atall ofoptional

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

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

cron_exprstringoptional

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

filterone ofoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/call_reports/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "email": "[e-mail]",
    "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
    }
  }'

200

4XX

200

No body

OK