OBJECT
Query
link GraphQL Schema definition
- type Query {
- # Client details
- #
- # Arguments
- # clientId: Id of the client
- LegacyId!): Client ( :
- # List the clients
- #
- # Arguments
- # clientIds: Filter to get clients by ids
- # hasCommunityEnabled: Filter to get clients with Community
- # feature enabled
- # hasIbbuEnabled: Filter to get clients with Ibbü feature enabled
- # before: Returns the elements in the list that come before the
- # specified cursor.
- # after: Returns the elements in the list that come after the
- # specified cursor.
- # first: Returns the first n elements from the list.
- # last: Returns the last n elements from the list.
- (
- LegacyId!], : [
- Boolean, :
- Boolean, :
- String, :
- String, :
- Int, :
- Int :
- ): ClientConnection
- # Connected users KPI
- #
- # Arguments
- # resourceFilters: Parameters used to filter the set of connected
- # users
- (
- ConnectedUserFilters :
- ): ConnectedUsersIndicator
- # The basic information of a connector
- #
- # Arguments
- # id: Id of the connector
- UUID!): Connector ( :
- # Get conversation closing form values by conversation and connector version
- #
- # Arguments
- # conversationId: Id of the iAdvize conversation
- # connectorVersionId: Id of the version of the connector
- (
- LegacyId!, :
- UUID! :
- ): [ConnectorConversationClosingFormValue!]
- # The details of the version of a connector
- #
- # Arguments
- # id: Id of the version of the connector
- UUID!): ConnectorVersion ( :
- # List installations which can be filtered by ids, by plugin type and by
- # installation state
- #
- # Arguments
- # connectorPluginType: Filter by plugin type
- # installationValidated: Filter by installation state
- # projectIds: Ids of the iAdvize project
- # before: Returns the elements in the list that come before the
- # specified cursor.
- # after: Returns the elements in the list that come after the
- # specified cursor.
- # first: Returns the first n elements from the list.
- # last: Returns the last n elements from the list.
- (
- ConnectorPluginType, :
- Boolean, :
- LegacyId!], : [
- String, :
- String, :
- Int, :
- Int :
- ): ConnectorVersionInstallationConnection
- # List connector version parameters for a connector version
- #
- # Arguments
- # connectorVersionId: Id of the version of the connector
- UUID): [ConnectorVersionParameter!] ( :
- # List connector versions
- #
- # Arguments
- # connectorVersionIds: Filter to get connectors by ids
- # before: Returns the elements in the list that come before the
- # specified cursor.
- # after: Returns the elements in the list that come after the
- # specified cursor.
- # first: Returns the first n elements from the list.
- # last: Returns the last n elements from the list.
- (
- UUID!], : [
- String, :
- String, :
- Int, :
- Int :
- ): ConnectorVersionConnection
- # List connectors which can be filtered by ids
- #
- # Arguments
- # connectorIds: Filter to get connectors by ids
- # before: Returns the elements in the list that come before the
- # specified cursor.
- # after: Returns the elements in the list that come after the
- # specified cursor.
- # first: Returns the first n elements from the list.
- # last: Returns the last n elements from the list.
- (
- UUID!], : [
- String, :
- String, :
- Int, :
- Int :
- ): ConnectorConnection
- # Retrieve conversation by its id
- #
- # Arguments
- # id: Id of the conversation
- UUID!): Conversation ( :
- # Conversation tag details
- #
- # Arguments
- # tagId: [Not documented]
- Int!): ConversationTag ( :
- # List the tags
- #
- # Arguments
- # tagIds: Filter to get tags by ids
- # projectId: Filter to get tags by a given website
- # before: Returns the elements in the list that come before the
- # specified cursor.
- # after: Returns the elements in the list that come after the
- # specified cursor.
- # first: Returns the first n elements from the list.
- # last: Returns the last n elements from the list.
- (
- Int!], : [
- Int, :
- String, :
- String, :
- Int, :
- Int :
- ): ConversationTagConnection
- # Production KPI
- #
- # Arguments
- # projectIds: Ids of the iAdvize project
- # channels: Filters conversations by channel
- # resourceFilters: Parameters used to filter the set of open
- # conversations (not closed)
- (
- LegacyId!]!, : [
- Channel!], : [
- OpenConversationFilters :
- ): ProductionIndicator
- # The project details
- #
- # Arguments
- # projectId: Id of the project
- LegacyId!): Project ( :
- # List the projects
- #
- # Arguments
- # before: Returns the elements in the list that come before the
- # specified cursor.
- # after: Returns the elements in the list that come after the
- # specified cursor.
- # first: Returns the first n elements from the list.
- # last: Returns the last n elements from the list.
- String, : String, : Int, : Int): ProjectConnection ( :
- # Look up a routing group given its identifier.
- #
- # Arguments
- # id: Identifier of the routing group.
- UUID!): RoutingGroup ( :
- # Look up routing groups.
- #
- # Arguments
- # websiteIds: Optional list of website identifiers to filter on.
- LegacyId!]): [RoutingGroup!] ( : [
- # Look up a routing rule given its identifier.
- #
- # Arguments
- # id: Identifier of the routing rule.
- UUID!): RoutingRule ( :
- # Look up routing rules.
- #
- # Arguments
- # websiteIds: Optional list of website identifiers to filter on.
- # name: Optional routing rule name segment to search on.
- LegacyId!], : String): [RoutingRule!] ( : [
- # Look up routing rules.
- #
- # Arguments
- # projectIds: Optional list of project identifiers to filter on.
- # name: Optional routing rule name segment to search on.
- # channel: Channel used
- # before: Returns the elements in the list that come before the
- # specified cursor.
- # after: Returns the elements in the list that come after the
- # specified cursor.
- # first: Returns the first n elements from the list.
- # last: Returns the last n elements from the list.
- (
- LegacyId!], : [
- String, :
- Channel, :
- String, :
- String, :
- Int, :
- Int :
- ): RoutingRuleConnection
- # List satisfaction survey responses for a given period
- #
- # Arguments
- # interval: Time interval
- # projectIds: Ids of the iAdvize project
- # cursor: Page start cursor
- (
- Interval!, :
- LegacyId!], : [
- String :
- ): SatisfactionSurveyResponses
- # List conversations matching search filters
- #
- # Arguments
- # interval: Conversation closing time interval
- # orderBy: Order of search results
- # after: To get next page of result
- # before: To get previous page of result
- # filters: Filters to limit search results
- # resourceFilters: WARNING: This is a work in progress, please do
- # not rely on this argument yet, as it may be removed in future versions. Filters
- # to limit search results
- (
- Interval!, :
- OrderBy, :
- String, :
- String, :
- SearchClosedConversationsFilters, :
- ClosedConversationFilters :
- ): SearchClosedConversationsResultConnection
- # Fetch a skill
- #
- # Arguments
- # skillId: Skill id to get
- LegacyId!): Skill ( :
- # List skills
- #
- # Arguments
- # skillIds: Skill ids to get
- # parentId: Id of the parent skill
- # name: Name of the skill
- # hasLocationInTree: Set to true if you want to return all skills
- # that have a location skill in their tree. Leave empty if not
- # hasDescendants: Set to true if you want to return all skills
- # that have a descendant skills.
- #
- # Set to false if you want to return all skills that have no descendant skills.
- #
- # Leave empty if you want all skills, whether they have descendants or not.
- # before: Returns the elements in the list that come before the
- # specified cursor.
- # after: Returns the elements in the list that come after the
- # specified cursor.
- # first: Returns the first n elements from the list.
- # last: Returns the last n elements from the list.
- (
- LegacyId!], : [
- Int, :
- String, :
- Boolean, :
- Boolean, :
- String, :
- String, :
- Int, :
- Int :
- ): SkillConnection
- # If a `userId` is passed, look up the given user.
- # If no `userId` is passed, fetch the currently authenticated user.
- #
- # Arguments
- # userId: Id of the user
- LegacyId): User ( :
- # Look up users
- #
- # Arguments
- # userIds: Look up users having any of the given ids
- # projectIds: Look up users able to handle conversations for any
- # of the given projects
- # emails: Look up users having specific email addresses
- # parentGroupId: List users belonging to a group that is a direct
- # or indirect child of the given group
- # externalIds: List users whose externalId match any of the given
- # values
- # skillIds: List users who have been assigned any of the given
- # skills
- # name: List users whose last name or first name contain the
- # given string
- # before: Returns the elements in the list that come before the
- # specified cursor.
- # after: Returns the elements in the list that come after the
- # specified cursor.
- # first: Returns the first n elements from the list.
- # last: Returns the last n elements from the list.
- (
- LegacyId!]!, : [
- LegacyId!]!, : [
- String!]!, : [
- LegacyId, :
- String!]!, : [
- LegacyId!]!, : [
- String, :
- String, :
- String, :
- Int, :
- Int :
- ): UserConnection
- # Retrieve visitor
- #
- # Arguments
- # visitorId: Id of the visitor
- UUID!): Visitor ( :
- # Get the custom data of a visitor for a conversation
- #
- # Arguments
- # conversationId: Id of the conversation
- (
- UUID! :
- ): VisitorConversationCustomData
- # Get the custom data of a visitor on a given project and communication channel
- #
- # Arguments
- # channel: Channel used
- # projectId: Id of the iAdvize project
- # legacyVisitorId: Id of the visitor
- (
- Channel!, :
- Int!, :
- String! :
- ): [VisitorCustomData!]
- }
link Require by
This element is not required by anyone