The iAdvize API offers deep and flexible integration with other systems, allowing you to transmit and retrieve structured data.

The API opens the door to advanced automation of reporting, administration, and service orchestration processes.

This programmable interface is essential for companies looking to customize their use of iAdvize, allowing constant adaptation and evolution according to specific needs.

With this advanced integration capability, you can maximize the efficiency of your operations and enhance your visitors' experience.

For more information on our APIs, you can consult the online documentation on our dev platform.

1. Accessing the GraphQL API

• Address: https://api.iadvize.com/graphql if your administration is on ha.iadvize.com, https://api-sd.iadvize.com/graphql if it is on sd.iadvize.com.
• Authentication: a token obtained with the email and password of an iAdvize user, sent in the Authorization: Bearer header. The procedure is described in the authentication documentation.
• Permissions: the data returned depends on the user’s role. For example, for closed conversations, an administrator or a manager gets the conversations of their projects (limited to their group if they belong to one), while an agent only gets their own conversations.
• Testing your queries: the Apollo explorer (https://ha.iadvize.com/apollo or https://sd.iadvize.com/apollo) uses your session: log in to your administration first.

Useful queries

• closedConversations: conversations closed over a period.
• conversation: the details of a conversation from its ID.
• conversions: transactions, which you can filter by period, project or conversation.
• visitorConversationCustomData: the visitor’s custom data for a conversation.

2. Exporting your data without the API

• Reports > Conversations: the Export button emails you a CSV file for the current period and filters. Messages can be included if you have the Access to the conversations messages export permission. Download links are valid for 7 days.
• Reports > Sales, Top Performances table: CSV download of the current view or of the first 10,000 entries.