Retrieve Dataset

This request retrieves the pre-set dataset of one of the data-objects that are being reported on.

Resource

GET /reports/dataset

Mandatory Parameters

Name Type Description

Name	Type	Description
`type`	String	Type/subject of the dataset
`start_date`	[Date] utc	Start date of the data
`end_date`	[Date] utc	End date of the data

type

String

Type/subject of the dataset

start_date

[Date] utc

Start date of the data

end_date

[Date] utc

End date of the data

Accepted values for the type parameter.

Dates must be in the format yyyy-MM-dd HH:mm:ss and must be no more than one year apart.

Optional Parameters

Optional filter parameters can be added to the API request after &where= and should be separated by comma’s.

Name Type Description

Name	Type	Description
`phoneLine.commonName`	String(s)	Name of the phone line(s)
`phone`	String(s)	Name of the phone(s)
`userProfile.commonName`	String(s)	Name of the user(s)
`incoming`	String	"incoming" or "1" for incoming, "outgoing" or "0" for outgoing communication
`external`	String	"external" or "1" for external, "internal" or "0" for internal communication
`onlyAnswered`	boolean	"true" or "1" for calls that do not have a blank callDurationSec value
`serviceLevelTime`	int	Time a call should be answered in to comply with the Service Level Agreement (only for the SLA dataset)
`benchmark`	int	Percentage of calls that should be answered within the SLA to satisfy the benchmark (only for the SLA dataset)

phoneLine.commonName

String(s)

Name of the phone line(s)

phone

String(s)

Name of the phone(s)

userProfile.commonName

String(s)

Name of the user(s)

incoming

String

"incoming" or "1" for incoming, "outgoing" or "0" for outgoing communication

external

String

"external" or "1" for external, "internal" or "0" for internal communication

onlyAnswered

boolean

"true" or "1" for calls that do not have a blank callDurationSec value

serviceLevelTime

int

Time a call should be answered in to comply with the Service Level Agreement (only for the SLA dataset)

benchmark

int

Percentage of calls that should be answered within the SLA to satisfy the benchmark (only for the SLA dataset)

Where multiple String arguments are possible, you can separate with the '~' character. For example: phone=Anne~Bob.

Accepted values for the `type` parameter

Base datasets

CALL_LOG
LOG_ENTRY
USER_CHAT
TENANT

Derived from CALL_LOG

CALLS_PER_USER
CALLS_PER_PHONELINE
CALLS_PER_PHONE
CALLS_PER_DAY_OF_THE_WEEK
CALLS_OVERVIEW
AFTER_CALL_TYPES_PER_PHONELINE
AFTER_CALL_TYPES_PER_USER
NUMBER_OF_CALLS_PER_DAY_OF_THE_WEEK_PER_HOUR
NUMBER_OF_MISSED_CALLS_PER_DAY_OF_THE_WEEK_PER_HOUR
AVERAGE_ANSWER_TIME_PER_DAY_OF_THE_WEEK_PER_HOUR
SERVICE_LEVEL_AGREEMENT
NUMBER_OF_INCOMING_CALLS_AND_DURATION_PER_RELATION
NUMBER_OF_OUTGOING_CALLS_AND_DURATION_PER_RELATION

Derived from LOG_ENTRY

USER_STATUS_REPORT
HOTDESKING

Derived from USER_CHAT

CHATS_PER_PHONELINE
EXTERNAL_CHATS_PER_PHONELINE
NUMBER_OF_CHATS_PER_DAY_OF_THE_WEEK_PER_HOUR
NUMBER_OF_CHATS_SESSIONS_PER_DAY_OF_THE_WEEK_PER_HOUR

Payload

None

Response

A text CSV of the dataset.

Context

Authorization

User

Errors

Common Errors

Example

Request

GET https://xelion.nl/api/v1/master/reports/dataset?
       type=call_log
       &start_date=2024-01-20 00:00:00
       &end_date=2025-01-19 00:00:00
       &where=phoneLine.commonName=Anne~Bob,
       incoming=1,
       onlyAnswered=true

Response

Headers

Content-Type:

text/csv;charset=UTF-8

…

Body

CSV content of the requested dataset