Skip to main content
GET
/
v1
/
agent-analytics
/
conversations
/
export
Export Conversations
curl --request GET \
  --url https://api.tryhamsa.com/v1/agent-analytics/conversations/export \
  --header 'Authorization: <api-key>'
"<string>"

Authorizations

​
Authorization
string
header
required

Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '

Query Parameters

​
voiceAgentId
string<uuid>
required

The unique identifier of the voice agent.

Example:

"48f7656f-098b-4c43-b165-7cfd2cc8ac30"

​
status
enum<string>

Filter conversations by status.

Available options:
COMPLETED,
PENDING,
FAILED,
IN_PROGRESS,
NO_ANSWER
Example:

"COMPLETED"

​
period
enum<string>
default:TODAY

The period filter option. Defaults to TODAY.

Available options:
LAST_HOUR,
TODAY,
YESTERDAY,
THIS_WEEK,
THIS_MONTH,
CUSTOM
Example:

"TODAY"

​
startPeriod
string

The start period timestamp in milliseconds sent in string format. Must be sent with CUSTOM date filter.

Example:

"1737590399000"

​
endPeriod
string

The end period timestamp in milliseconds sent in string format. Must be sent with CUSTOM date filter.

Example:

"1737590399000"

​
timeDifference
string
default:0

The time difference between the timezone of the user's machine to the UTC/GMT timezone.

Example:

"-3"

Response

Successful response - returns Excel file download

The response is of type file.