Operator management
Operator management
POST Bulk-update operator availability status — Updates the availability status for multiple operators in the current organization. Admin access is required.POST Create an operator — Creates an operator record for the current organization. Admin access is required.GET Get operator availability schedule — Returns the saved recurring availability schedule and timezone for one operator in the current organization.GET Get operator statistics — Returns performance statistics for one operator in the current organization.GET Get org-wide operator leaderboard — Returns a ranked leaderboard of operators in the current organization.POST Invite an operator to the organization — Invites a user into the current organization as an operator, admin, or viewer. Admin access is required.GET List organization operators with status — Lists operators in the current organization together with their profile, presence status, and active conversation counts.DELETE Remove an operator from the organization — Removes one operator from the current organization. Admin access is required.PUT Update operator availability schedule — Updates one operator's recurring availability schedule and optional timezone. Admin access is required.PATCH Update operator settings — Updates one operator's assignment settings in the current organization. Admin access is required. Only provided fields are changed.PATCH Update operator status — Updates one operator's presence status inside the current organization. Admin access is required.Was this page helpful?
Get visitor statistics
Returns aggregate visitor statistics for the current organization. Only authenticated operators can access this data; widget visitors are limited to their own tracking history. The response can include totals, online visitor counts, and breakdowns such as country or traffic source when that data is available. The exact keys depend on which tracking data has been collected for the organization. Authenticate with an organization API key sent in `X-API-Key` or as a Bearer token and carrying the exact `tracking:read` scope. API-key access also requires the Automation & API module (`automation_api`). Authorized dashboard sessions remain supported where the route already permits them. The request is isolated to the authenticated organization. Resource and site/project identifiers must belong to that organization; out-of-scope identifiers are not disclosed. The response contains aggregate organization tracking data. Keys can vary as additional dimensions become available, so clients should tolerate additive fields. Retry behavior: This read-only operation is safe to retry.
Bulk-update operator availability status
Updates the availability status for multiple operators in the current organization. Admin access is required. When `operatorIds` is omitted or empty, the new status is applied to every operator in the organization. The response returns the number of affected operators in `affected`. Access requires an active organization administrator session or an organization API key with the `operators:write` scope. API-key calls also require the automation API module. Data is isolated to the authenticated organization; identifiers from another organization or site are not disclosed.