Skip to navigation

Get attempts

View as Markdown

Returns a page of attempts for one agent in a date range. An attempt is one try at reaching a user, connected or not — use it for connection rates, failures and retries. A connected attempt links to its conversation through interaction_id.

Responses are cached for 60 seconds. Each item includes user_contact, the user’s full, unmasked phone number or email. Treat responses as personal data.

Path parameters

org_idstringRequired
Organization ID.
workspace_idstringRequired
Workspace ID.
app_idstringRequired

Agent ID. Copy it from the agent’s ··· menu in the dashboard (Copy agent ID).

Headers

X-API-KeystringRequired
Your workspace API key.

Query parameters

sort_byenumOptionalDefaults to attempt_id

Field to sort by. Default attempt_id. Unknown values return 422.

sort_orderenumOptionalDefaults to asc

asc (default) or desc. Case-insensitive.

Allowed values:
start_datetimedatetimeRequired

Start of the range, inclusive. ISO 8601 with an offset, e.g. 2026-10-01T00:00:00+05:30 (encode + as %2B). Without an offset, UTC is assumed.

end_datetimedatetimeRequired

End of the range, inclusive. Same format as start_datetime, and must be later than it.

limitintegerOptional1-1000Defaults to 20

Items per page, 1–1000. Default 20.

offsetintegerOptional>=0Defaults to 0

Items to skip. Default 0. To page, you can follow next_page_uri instead.

filter_conditionsstringOptional

URL-encoded JSON array of {field, operator, value} conditions. value is always a string, even for numbers. Conditions on the same field are ORed; on different fields, ANDed.

[{"field": "duration_in_seconds", "operator": "greater_than", "value": "30"}]

Operators and filterable fields are listed under Filtering.

Response

A page of attempts.
itemslist of objects
The attempts on this page.
totalinteger
Total number of attempts matching the request, across all pages.
limitinteger

The limit applied to this page.

offsetinteger

The offset applied to this page.

next_page_uristring

Query string for the next page, e.g. ?start_datetime=...&limit=20&offset=20. Append it to the endpoint path. "" when there is no next page.

prev_page_uristring

Query string for the previous page. "" when there is none.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error