Call reports

List call reports

get

/call_reports

Authorizations

Query parameters

filterstring

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

searchstring

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

orderbystring

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: 0

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: 100

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": [
    {
      "name": "text",
      "cron_expr": "text",
      "type": "NORMAL",
      "status": "RUNNING",
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
    }
  ]
}

OK

Create new call report

post

/call_reports

Authorizations

Body

namestringrequired

The name of call report.

cron_exprstring

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

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:

Options: 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

formatstring · enumrequired

The report output files format can be either:

• CSV:
• HTML:

Options: CSV, HTML

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.

Options: TODAY, YESTERDAY, LAST_WEEK, LAST_SEVEN_DAYS, LAST_MONTH, LAST_THIRTY_DAYS, CUSTOM

emailall ofrequired

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

The email address.

started_atall of

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 of

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

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",
    "cron_expr": "text",
    "type": "NORMAL",
    "format": "CSV",
    "range": "TODAY",
    "email": "[e-mail]",
    "started_at": "2017-07-21T17:32:28Z",
    "ended_at": "2017-07-21T17:32:28Z",
    "filter": {
      "from_value": "text",
      "to_value": "text",
      "duration_from": 1,
      "duration_to": 1,
      "from": "ANY",
      "to": "ANY",
      "answer_state": "ANY",
      "duration": "ANY"
    }
  }'

201

4XX

201

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created

Get call report details

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

get

/call_reports/{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

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

OK

Update call report

Update call report properties.

post

/call_reports/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of this call report.

The unique ID of the resource.

Body

namestring

The name of call report.

cron_exprstring

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

formatstring · enum

The report output files format can be either:

• CSV:
• HTML:

Options: CSV, HTML

rangestring · enum

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.

Options: TODAY, YESTERDAY, LAST_WEEK, LAST_SEVEN_DAYS, LAST_MONTH, LAST_THIRTY_DAYS, CUSTOM

emailall of

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

The email address.

started_atall of

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 of

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

filterone of

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",
    "cron_expr": "text",
    "format": "CSV",
    "range": "TODAY",
    "email": "[e-mail]",
    "started_at": "2017-07-21T17:32:28Z",
    "ended_at": "2017-07-21T17:32:28Z",
    "filter": {
      "from_value": "text",
      "to_value": "text",
      "duration_from": 1,
      "duration_to": 1,
      "from": "ANY",
      "to": "ANY",
      "answer_state": "ANY",
      "duration": "ANY"
    }
  }'

200

4XX

200

No body

OK