Skip to main content
POST
Get agent logs
All filters are optional and go directly in the request body. Unknown fields and custom-analysis filters return 400. Results are sorted by session start time, newest first. Increase page while pagination.has_more is true. Keep the same size and filters. No matches or size: 0 returns an empty data array with pagination.has_more: false. See review agent logs for examples.

Authorizations

Authorization
string
header
required

API key in the format: Bearer YOUR_KARTA_API_KEY.

Body

application/json
page
integer
default:1

Page number.

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

Results per page. Use 0 to return an empty data array.

Required range: 0 <= x <= 500
call_id
string

Call identifier.

batch_id
string

Batch identifier.

agent_id
string

Agent identifier.

Example:

"agentexample"

branch_id
string

Agent branch identifier.

call_status
string

Call status. Use all to include every value.

Example:

"ended"

call_direction
string

Call direction. Use all to include every value.

Example:

"inbound"

agent_name
string

Wildcard substring search on the agent name.

to_number
string

Wildcard substring search on either phone number.

call_start_timestamp
string<date-time>

Start of the call-time filter, using session timestamps.

call_end_timestamp
string<date-time>

End of the call-time filter, using session timestamps.

session_start_timestamp
string<date-time>

Start of the session-time filter.

session_end_timestamp
string<date-time>

End of the session-time filter.

duration_min
number

Minimum talk time in seconds (inclusive).

duration_max
number

Maximum talk time in seconds (inclusive).

call_disconnected_by
string

Party that disconnected the call.

call_transfer_status
string

Call transfer status.

Response

Matching call logs, ordered by session start time, newest first.

data
object[]
pagination
object