Skip to main content
GET
Get conversations report

Authorizations

Authorization
string
header
required

API token in the sk_live_… format.

Query Parameters

page
integer
default:1

Page number, starting at 1. An invalid value is treated as 1.

Required range: x >= 1
perPage
integer
default:20

Number of items per page. The maximum depends on the environment (default 100).

Required range: 1 <= x <= 100
date_start
string
required

Start of the period, in the company time zone: YYYY-MM-DD or YYYY-MM-DD HH:mm:ss. With only the date, it starts at 00:00:00.

date_finish
string
required

End of the period, in the same format. With only the date, it runs until 23:59:59 of that day.

dateType
enum<string>
default:updated

updated considers the creation, closing and update dates. created considers only the creation date.

Available options:
updated,
created
days
integer

Alternative to the period: the last N days.

status
string
users
string

Agent ids (the id from GET /users), separated by commas. An agent that is not from your company returns 404 (ERR_API_USER_NOT_FOUND).

queues
string

Queue ids, separated by commas. An id that is not from your company returns 422 (ERR_API_INVALID_REFERENCE).

channels
string

Channel ids, separated by commas. An id that is not from your company returns 422 (ERR_API_INVALID_REFERENCE).

tags
string

Tag ids, separated by commas. An id that is not from your company returns 422 (ERR_API_INVALID_REFERENCE).

wrapupTypes
string

Wrap-up ids, separated by commas. An id that is not from your company returns 422 (ERR_API_INVALID_REFERENCE).

contactSearchParams
string

Search by contact.

protocol
string

Ticket protocol number.

conversationType
enum<string>

Conversation type: inbound, outbound, campaign or scheduled. How the conversation started:

Available options:
incoming,
outcoming,
campaign,
outcoming_api,
outcoming_automation,
outcoming_schedule

Response

OK

data
object[]
meta
object
Example: