Magidoc

Query
Object

Fields

#

closedConversations

List of conversations matching your search filters.

connectedUsersIndicator

Connected users KPI.

connectorConversationClosingFormValues

Get conversation closing form values by conversation and connector version.

This field is now deprecated. This means that iAdvize now considers that this field should not be used and you should migrate any usage of that field. iAdvize will only maintain this field up until the 2025-04-07.

connectorVersion

The details of the version of a connector.

connectors

List connectors which can be filtered by ids.

conversation

Retrieve conversation by its id.

conversationTag

Conversation tag details.

conversationTags

List the tags.

conversion

Fetch a transaction by its id.

conversions

List and filter transactions.

engagementCampaign

Retrieve an Engagement campaign thanks to its id.

engagementCampaignsV2

Lists all the engagement campaigns for a given project id.

knowledgeSource

Fetch a Knowledge Source by its ID.

metrics

Namespace for metrics queries.

productionIndicator

Production KPI.

professionalBaseRoles

List the base roles that can be used to create new roles.

professionalRoles

List the roles available to the client.

project

The project details.

projects

List the projects.

routingGroup

Look up a routing group given its identifier.

routingGroups

Look up routing groups.

This field is now deprecated. This means that iAdvize now considers that this field should not be used and you should migrate any usage of that field. iAdvize will only maintain this field up until the 2025-04-07.

routingGroupsV2

Look up routing groups.

routingRule

Look up a routing rule given its identifier.

routingRules

Look up routing rules.

This field is now deprecated. This means that iAdvize now considers that this field should not be used and you should migrate any usage of that field. iAdvize will only maintain this field up until the 2025-04-07.

routingRulesV2

Look up routing rules.

satisfactionSurveyResponses

List satisfaction survey responses for a given period.

searchClosedConversations

List conversations matching search filters.

This field is now deprecated. This means that iAdvize now considers that this field should not be used and you should migrate any usage of that field. iAdvize will only maintain this field up until the 2025-04-07.

skill

Fetch a skill.

skills

List skills.

user

If a userId is passed, look up the given user. If no userId is passed, fetch the currently authenticated user.

userGroups

List user groups.

users

Look up users.

visitor

Retrieve visitor.

visitorConversationCustomData

Get the custom data of a visitor for a conversation.

visitorCustomData

Get the custom data of a visitor on a given project and communication channel.

visitors

List visitors.