Developer Platform
  • Home
  • Getting Started
    • General Information
    • Features Overview
    • Security
  • APPs
    • Public Apps
      • Shopify
      • Salesforce
      • Zendesk
      • Google Analytics
    • Build your App
      • Getting started
      • My Apps
      • App information
      • App Parameters
      • App Plugins
      • Add Webhooks
      • Submit your Apps
      • App security
      • Developer Policy
  • Use Cases
    • Copilots
      • Product Catalog sync through API
      • FAQ sync through API
    • Visitor experience
      • Integrating custom buttons into your site
      • Check availability before escalating to iAdvize
      • Authenticated Messaging
        • Introduction
        • Web client-side implementation
          • Authenticated Messaging overview
          • Brief timeline of the integration process
          • How to enable authenticated mode in the administration portal?
          • How to implement the customer authentication backend (token provider)?
          • How to authenticate with iAdvize in client's website?
          • How to deal with activation success or failure?
          • How to logout?
          • Compatibility with Mobile SDK
          • FAQ
        • Web backend implementation
          • Important information and recommendations
          • Signature and Encryption Detailed Process
          • Technical backend implementation
          • FAQ
      • Cross-domain Conversation Continuity
      • Customize replies with Markdown
    • Agent workspace
      • Custom App example and step-by-step tutorial
        • Get Started
        • Work with the Desk
        • Intent / Trigger
        • JWT
        • References
    • Administration
      • Users
        • SAML SSO Authentication - Implementation Guide
        • Create, update and delete users via API
        • Manage the availability of your users with the iAdvize API
        • Integrate the iAdvize conversation panel into an existing tool
      • Anonymize a conversation or visitor data
    • Data & Analytics
      • Extract conversation transcript
      • Retrieve metrics and KPIs
        • Pre-aggregated indicators
        • Understand transaction data
        • Understand conversation data 1/2
        • Understand conversation data 2/2
        • Understand satisfaction data
        • Understand production indicators
        • Understand connected users indicators
  • Technologies
    • GraphQL API
      • Terminology
      • Reference
      • Authentication
      • Schema lifecycle
      • Error Management
      • Pagination
    • REST API (deprecated)
      • Statistic (deprecated)
      • Group (deprecated)
      • Call meeting (deprecated)
      • Operator (deprecated)
      • Skill (deprecated)
      • Transaction (deprecated)
      • Visitor (deprecated)
    • Webhooks
      • Reference
      • Guides
    • Desk events
      • Reference
    • Web & Mobile SDK
      • Javascript Web SDK
        • Reference
      • Javascript Callbacks
        • Reference
        • Guides
      • Mobile SDK
        • Gaperon (latest)
        • Fourme
        • Epoisses
        • Dauphin
        • 🤝Support Policy
        • 🤔Frequently Asked Questions
    • Custom App
    • External Bot
      • Implementation
        • Configuration flow
        • Conversation flow
        • Conversation objects
      • Configuration
      • FAQ
      • Best practices
Powered by GitBook
On this page
  • What is the connectedUsersIndicator query for?
  • Available filters
  • Response fields
  • Next steps

Was this helpful?

  1. Use Cases
  2. Data & Analytics
  3. Retrieve metrics and KPIs

Understand connected users indicators

The connectedUsersIndicator query allows you to monitor live user availability on the iAdvize platform. It provides visibility into how many users are connected, how many are available for chat, and how occupied they are, helping you understand team readiness in real time.

What is the connectedUsersIndicator query for?

You can use this query to retrieve indicators about users who are currently connected to iAdvize, with details about:

  • Their availability status

  • Their chat availability

  • Their occupancy level in production

Available filters

You can fine-tune your query with the following filters:

Filter
Description

availabilityStatus

Filter by user availability status (AVAILABLE, BUSY, TOGGLE_OFF)

chatAvailability

Filter by chat availability (AVAILABLE, BUSY, TOGGLE_OFF)

groupIds

Filter by user group IDs

projectIds

Filter by project ID(s)

roles

Filter by user role(s): operator, manager, admin, expert, bot

routingGroupIds

Filter by routing group IDs

userIds

Filter by specific user ID(s)

You can combine multiple filters to scope the results to specific teams, projects, or user segments.

Response fields

The API response includes three key indicators:

1. connectedUsersCount (Int!)

Total number of users currently connected to the iAdvize desk.

  • This reflects all users actively logged in, regardless of availability or role.

2. countByChatAvailabilityStatus (ChannelGroupAvailabilityStatus)

Number of users currently connected and available, broken down by chat availability status (AVAILABLE, BUSY, TOGGLE_OFF).

  • This allows you to see how many users are available or busy on the chat channel.

  • It helps you assess how ready your team is to handle new incoming conversations.

3. usersInProductionChatOccupancy (UsersInProductionOccupancy)

Detailed average chat occupancy of users currently in production. This includes:

Field
Description

maximumSimultaneousConversationAverage (Float!)

Average of max processing capacity (maxSlots) of agents in production, on the Chat channel

simultaneousConversationAverage (Float!)

Average slots (currentSlots) currently taken by agents in production

occupancyRate (Float!) %

Total number of slots currently taken by agents in production divided by the total number of slots defined by these agents in the chat channel. (sum(currentSlots) / sum(maxSlots))

What does occupancy represent? Occupancy reflects the period during which an agent is logged in to the conversation panel and is partially occupied or occupied to maximum capacity.

Next steps

You can test this query and explore the full schema in the iAdvize GraphQL API Explorer.

For more insights on building complete dashboards, you may also be interested in:

  • Production Indicator

  • Pre-aggregated Indicators

PreviousUnderstand production indicatorsNextGraphQL API

Last updated 9 days ago

Was this helpful?