OBJECT

Query

link GraphQL Schema definition

  • type Query {
  • # Client details
  • #
  • # Arguments
  • # clientId: Id of the client
  • client(clientId: 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.
  • clients(
  • clientIds: [LegacyId!],
  • hasCommunityEnabled: Boolean,
  • hasIbbuEnabled: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ClientConnection
  • # Connected users KPI
  • #
  • # Arguments
  • # resourceFilters: Parameters used to filter the set of connected
  • # users
  • connectedUsersIndicator(
  • resourceFilters: ConnectedUserFilters
  • ): ConnectedUsersIndicator
  • # The basic information of a connector
  • #
  • # Arguments
  • # id: Id of the connector
  • connector(id: 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
  • connectorConversationClosingFormValues(
  • conversationId: LegacyId!,
  • connectorVersionId: UUID!
  • ): [ConnectorConversationClosingFormValue!]
  • # The details of the version of a connector
  • #
  • # Arguments
  • # id: Id of the version of the connector
  • connectorVersion(id: 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.
  • connectorVersionInstallations(
  • connectorPluginType: ConnectorPluginType,
  • installationValidated: Boolean,
  • projectIds: [LegacyId!],
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ConnectorVersionInstallationConnection
  • # List connector version parameters for a connector version
  • #
  • # Arguments
  • # connectorVersionId: Id of the version of the connector
  • connectorVersionParameters(connectorVersionId: 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.
  • connectorVersions(
  • connectorVersionIds: [UUID!],
  • before: String,
  • after: String,
  • first: Int,
  • last: 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.
  • connectors(
  • connectorIds: [UUID!],
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ConnectorConnection
  • # Retrieve conversation by its id
  • #
  • # Arguments
  • # id: Id of the conversation
  • conversation(id: UUID!): Conversation
  • # Conversation tag details
  • #
  • # Arguments
  • # tagId: [Not documented]
  • conversationTag(tagId: 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.
  • conversationTags(
  • tagIds: [Int!],
  • projectId: Int,
  • before: String,
  • after: String,
  • first: Int,
  • last: 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)
  • productionIndicator(
  • projectIds: [LegacyId!]!,
  • channels: [Channel!],
  • resourceFilters: OpenConversationFilters
  • ): ProductionIndicator
  • # The project details
  • #
  • # Arguments
  • # projectId: Id of the project
  • project(projectId: 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.
  • projects(before: String, after: String, first: Int, last: Int): ProjectConnection
  • # Look up a routing group given its identifier.
  • #
  • # Arguments
  • # id: Identifier of the routing group.
  • routingGroup(id: UUID!): RoutingGroup
  • # Look up routing groups.
  • #
  • # Arguments
  • # websiteIds: Optional list of website identifiers to filter on.
  • routingGroups(websiteIds: [LegacyId!]): [RoutingGroup!]
  • # Look up a routing rule given its identifier.
  • #
  • # Arguments
  • # id: Identifier of the routing rule.
  • routingRule(id: 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.
  • routingRules(websiteIds: [LegacyId!], name: 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.
  • routingRulesConnection(
  • projectIds: [LegacyId!],
  • name: String,
  • channel: Channel,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): RoutingRuleConnection
  • # List satisfaction survey responses for a given period
  • #
  • # Arguments
  • # interval: Time interval
  • # projectIds: Ids of the iAdvize project
  • # cursor: Page start cursor
  • satisfactionSurveyResponses(
  • interval: Interval!,
  • projectIds: [LegacyId!],
  • cursor: 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
  • searchClosedConversations(
  • interval: Interval!,
  • orderBy: OrderBy,
  • after: String,
  • before: String,
  • filters: SearchClosedConversationsFilters,
  • resourceFilters: ClosedConversationFilters
  • ): SearchClosedConversationsResultConnection
  • # Fetch a skill
  • #
  • # Arguments
  • # skillId: Skill id to get
  • skill(skillId: 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.
  • skills(
  • skillIds: [LegacyId!],
  • parentId: Int,
  • name: String,
  • hasLocationInTree: Boolean,
  • hasDescendants: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: 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
  • user(userId: 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.
  • users(
  • userIds: [LegacyId!]!,
  • projectIds: [LegacyId!]!,
  • emails: [String!]!,
  • parentGroupId: LegacyId,
  • externalIds: [String!]!,
  • skillIds: [LegacyId!]!,
  • name: String,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): UserConnection
  • # Retrieve visitor
  • #
  • # Arguments
  • # visitorId: Id of the visitor
  • visitor(visitorId: UUID!): Visitor
  • # Get the custom data of a visitor for a conversation
  • #
  • # Arguments
  • # conversationId: Id of the conversation
  • visitorConversationCustomData(
  • conversationId: 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
  • visitorCustomData(
  • channel: Channel!,
  • projectId: Int!,
  • legacyVisitorId: String!
  • ): [VisitorCustomData!]
  • }

link Require by

This element is not required by anyone