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]
    Hide data attributes Show data attributes object

    • ambassador object

      Additional properties are allowed.

      Hide ambassador attributes Show ambassador attributes object

      • id_ambassador integer(int32)
      • image string
      • firstname string
      • lastname string
      • username string
      • email string
      • email_tmp string
      • active integer(int32)
      • status integer(int32)
      • online boolean

        true: when last_action_date is less than 5 minutes ago

      • last_action_date string(date-time)
      • customer_id string
      • anonymized boolean
    • nb_new_dialogues integer(int32)
    • nb_active_dialogues integer(int32)
    • nb_closed_conversations integer(int32)
    • average_rating number(float)
    • nb_chat_sales integer(int32)
    • total_paid number(float)
    • session_time integer(int32)
    • nb_handled_requests integer(int32)
    • nb_conv_without_member_msg integer(int32)
  • 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