Get ambassador activity

GET /manager/bi/realtime/activity

Query parameters

sort string

Sort by a specific field( for example: sort=-session_time)

Values are session_time, average_rating, nb_new_dialogues, nb_active_dialogues, nb_conv_without_member_msg, nb_handled_requests, nb_closed_conversations, nb_chat_sales, total_paid, or last_action_date.
filter[online_only] boolean

Filter by online users only
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.
filter[ignore_inactive] boolean

Filter by active users only
page integer

page number
per_page integer

number of items per page

Responses

200 application/json

Returns all ambassadors activity (paginated)
Hide response attributes Show response attributes object
- current_page integer(int32)
- data array[object]
  
  Additional properties are allowed.
- first_page_url string
- from integer(int32)
- last_page integer(int32)
- last_page_url string
- links array[object]
  
  Hide links attributes Show links attributes object
  
  url string(nullable)
  
  label string
  
  active boolean
- next_page_url string
- path string
- per_page integer(int32)
- prev_page_url string(nullable)
- to integer(int32)
- total integer(int32)
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/activity

curl \
 --request GET 'https://domain.tld/api/v2/manager/bi/realtime/activity' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "current_page": 42,
  "data": [
    {}
  ],
  "first_page_url": "string",
  "from": 42,
  "last_page": 42,
  "last_page_url": "string",
  "links": [
    {
      "url": "string",
      "label": "string",
      "active": true
    }
  ],
  "next_page_url": "string",
  "path": "string",
  "per_page": 42,
  "prev_page_url": "string",
  "to": 42,
  "total": 42
}

Response examples (401)

{
  "message": "Unauthorized."
}