GET
/
analytics
/
v1
/
{org_id}
/
{workspace_id}
/
{app_id}
/
interactions
Get interactions
curl --request GET \
  --url https://apps.sarvam.ai/api/analytics/v1/{org_id}/{workspace_id}/{app_id}/interactions
{
  "items": [
    {
      "interaction_id": "<string>",
      "user_identifier": "<string>",
      "duration_in_seconds": 123,
      "start_datetime": "2023-11-07T05:31:56Z",
      "end_datetime": "2023-11-07T05:31:56Z",
      "language_name": "<string>",
      "num_messages": 123,
      "average_agent_response_time_in_seconds": 123,
      "average_user_response_time_in_seconds": 123,
      "user_contact_masked": "<string>",
      "user_contact_hashed": "<string>",
      "channel_direction": "<string>",
      "retry_attempt": 123,
      "campaign_id": "<string>",
      "cohort_id": "<string>",
      "is_debug_call": 123,
      "audio_url": "<string>",
      "job_id": "<string>",
      "channel_type": "<string>",
      "channel_provider": "<string>",
      "channel_protocol": "<string>",
      "server_retry_attempt": 123,
      "failure_reason": "<string>",
      "ended_by": "<string>",
      "has_log_issues": 123,
      "agent_variables": {}
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123,
  "next_page_uri": "<string>",
  "prev_page_uri": "<string>"
}

Headers

​
X-API-Key
string | null

Path Parameters

​
org_id
string
required

Organization ID

​
workspace_id
string
required

Workspace ID

​
app_id
string
required

Agent ID

Query Parameters

​
sort_by
string | null

Field to sort by

​
sort_order
string | null

Sort order (asc or desc)

​
start_datetime
string<date-time>
required

Filter start datetime in UTC (ISO8601)

​
end_datetime
string<date-time>
required

Filter end datetime in UTC (ISO8601)

​
limit
integer
default:20

Max number of records to return

Required range: 1 <= x <= 1000
​
offset
integer
default:0

Number of records to skip

Required range: x >= 0
​
filter_conditions
string | null

JSON array of filter conditions. Each condition has: id (string), field (from available fields), operator (equals/not_equals/includes/starts_with/ends_with for strings; equals/not_equals/greater_than/less_than for numbers), value. Example: [{"id":"1","field":"interaction_id","operator":"equals","value":"abc123"}]

Response

Successful Response

​
items
ExternalInteractionsAPIResponse · object[]
required
​
total
integer
required
​
limit
integer
required
​
offset
integer
required
​
next_page_uri
string | null
​
prev_page_uri
string | null