Skip to main content
POST
Admin Queue Logs

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
startDate
string
required

Start date for the report period

endDate
string
required

End date for the report period

tenantId
number

Tenant ID; lists events across all of its queues

queueId
number[]

Queue IDs to include (required for queue managers without reporting.queues)

events
enum<string>[]

Filter by queue event types

Available options:
AGENT_COMPLETE
users

Filter by user peer names, or 'ALL' for all users

tag
string[]

Filter by call tags

Minimum array length: 1
callId
string

Filter by specific call ID

reportType

Report type (Scheduled, Export, or Live)

Available options:
Scheduled
query
string

Search by caller number, name or call ID

callbacksOnly
boolean

Only events belonging to queue callback calls

paginated
integer
default:1

1 = paginated response, 0 = full list

Required range: 0 <= x <= 1
page
number

Page number

recordsPerPage
number

Records per page

sortBy
string

Sort column

Maximum string length: 50
sortDirection
enum<string>

Sort direction

Available options:
asc,
desc

Response

200 - application/json

Queue logs or export acknowledgement

Paginated queue logs

records
object[]
required
page
number
required
maxPage
number
required
totalRecords
number
required