REST API Reference for Conversations History

Description of all REST API endpoints for getting users’ conversation data

Conversations History

You can download your users’ conversations with the bot. The API requires the bot id and authentication with the bot server access token. You can find them in the bot Settings.

Important: Results from a GET query are limited to 1000 elements. If your query produces more than that number of matching elements, only the first 1000 will be returned.

Replace the [bot id] and [bot server access token] in the examples below.

Conversations

Returns a list of all conversations.

curl \
-H "Content-Type: application/json" \
-H "Authorization: Bot-Server-Access-Token [bot server access token]" \
-X GET https://api.nativechat.com/v1/bots/[bot id]/conversations

Conversation messages

Returns a list of all messages in a conversation.

curl \
-H "Content-Type: application/json" \
-H "Authorization: Bot-Server-Access-Token [bot server access token]" \
-X GET https://api.nativechat.com/v1/bots/[bot id]/messages?query=%7B%22Conversation%22%3A%[conversation id]%22%7D

Queries

limit

Limits the number of elements in the result.

/v1/bots/[bot id]/conversations?limit=100

skip

Skips the first N elements in the result that match the query.

/v1/bots/[bot id]/conversations?skip=100

sort

Sorts the elements in the result by one ot more properties.

/v1/bots/[bot id]/conversations?sort=StartedAt

/v1/bots/[bot id]/conversations?sort={"Data.user.FirstName":-1, "Data.user.LastName": 1}

query

Filters the elements with MongoDB query predicates.

The queries support filtering by a single or multiple properties, nested properties, logical and comparison operators.

/v1/bots/[bot id]/messages?query={"User":"[user-id]"}

/v1/bots/[bot id]/conversations?query={"Data.channel.ProviderName":"facebook","Status":"success"}

/v1/bots/[bot id]/conversations?query={"$or":[{"Data.channel.ProviderName":"facebook"},{"Data.channel.ProviderName":"viber"}]}

/v1/bots/[bot id]/conversations?query={"Errors":{"$gt":0}}

/v1/bots/[bot id]/conversations?query={"Messages.user":{"$gt":3}}

count

Returns the count of the elements that match a query.

/v1/bots/[bot id]/conversations/_count?query={"Data.channel.ProviderName":"facebook"}

/v1/bots/[bot id]/messages/_count?query={"Conversation":"[conversation-id]"}