Use the Analytics End Points to retrieve performance and engagement data such as contact lists, pending responses, and agent response times. Useful for building dashboards or improving support workflows.
🔽 GET /api/public/analytics/contacts – Get Contacts Info
Retrieves contact information filtered by channel and ordered by field.
Click to expand full details
🔹 URL
GET /api/public/analytics/contacts
🔹 Query Parameters
Name
Type
Required
Description
channel
string
✅
The channel to retrieve contacts from (e.g., whatsapp)
orderBy
string
✅
Field to sort by (contact_created_at)
page
number
✅
Page number to retrieve
🔹 Headers
Name
Type
Required
Description
x-api-key
string
✅
Your API key for authorization
🔹 Example Request
curl --request GET \
'https://iris-backend-production.up.railway.app/api/public/analytics/contacts?channel=whatsapp&orderBy=contact_created_at&page=1' \
--header 'x-api-key: YOUR_API_KEY'
🔽 GET /api/public/analytics/contacts/pending-responses – Get Contacts with Pending Responses
Returns contacts with unanswered messages, sorted by waiting time (descending).
Click to expand full details
🔹 URL
GET /api/public/analytics/contacts/pending-responses
🔹 Query Parameters
Name
Type
Required
Description
channel
string
✅
Channel (e.g., whatsapp)
pipelineId
string
✅
ID of the pipeline to filter by
page
number
✅
Page number
🔹 Headers
Name
Type
Required
Description
x-api-key
string
✅
Your API key for authorization
🔹 Example Request
curl --request GET \
'https://iris-backend-production.up.railway.app/api/public/analytics/contacts/pending-responses?channel=whatsapp&pipelineId=pipeline_123&page=1' \
--header 'x-api-key: YOUR_API_KEY'
🔽 GET /api/public/analytics/agents/response-time – Get Average Response Time by Agent
Returns average response times (in seconds) for each agent in a specified channel.
Click to expand full details
🔹 URL
GET /api/public/analytics/agents/response-time
🔹 Query Parameters
Name
Type
Required
Description
channel
string
✅
Channel to filter (e.g., whatsapp)
page
number
✅
Page number
🔹 Headers
Name
Type
Required
Description
x-api-key
string
✅
Your API key for authorization
🔹 Example Request
curl --request GET \
'https://iris-backend-production.up.railway.app/api/public/analytics/agents/response-time?channel=whatsapp&page=1' \
--header 'x-api-key: YOUR_API_KEY'
