Get real time conversations KPI's

GET /manager/bi/realtime/chatrooms
Bearer token

Query parameters

  • filter[id_ambassador] integer

    Filter by id ambassador

  • filter[status] string

    Filter by ambassador status (0: ambassador, 1: employee, 2: administrator, 3: seller, 4: shop manager, 5: manager, 6: expert)

    Values are 0, 1, 2, 3, 4, 5, or 6.

Responses

  • 200 application/json

    Returns all real time conversations KPI's

    Hide response attributes Show response attributes object
    • on_going_conversations integer
    • new_dialogues integer
    • active_dialogues integer
    • closed_conversations integer
    • average_rating integer
    • conversation_without_member_message integer
  • 401 application/json

    Unauthorized.

    Hide response attribute Show response attribute object
    • message string
  • 403

    Forbidden - You don't have permission to access this route

GET /manager/bi/realtime/chatrooms 
curl \
 --request GET 'https://domain.tld/api/v2/manager/bi/realtime/chatrooms' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "on_going_conversations": 10,
  "new_dialogues": 10,
  "active_dialogues": 10,
  "closed_conversations": 10,
  "average_rating": 10,
  "conversation_without_member_message": 10
}
Response examples (401) 
{
  "message": "Unauthorized."
}