Docs
DashboardRelease Notes
  • What is DeepConverse?
  • Chatbots
    • Basics
      • Building chatbot intents
      • Intent action responses
      • Chatbot Persistence mode
      • Publishing changes
    • Advanced Functionality
      • Connection Override
      • User Identity Verification
      • Announcements
      • Channel Specific Functionality
        • Zendesk Sunshine Conversations
          • How to handle image and file uploads in Zendesk Sunshine Conversations?
        • Zendesk Chat (Classic)
          • How to handoff conversations to Zendesk Chat (Classic) ?
        • Calendly
    • Branding
    • Deploy
      • Chatbot Versioning
      • iOS SDK
        • iOS (Custom Webview)
      • Android SDK
      • Adding widget to your Zendesk Help Center
      • Adding widget to your website
      • Custom Initialization and Passing Metadata
      • Open chatbot via Javascript
      • Adding widget to your Shopify Store
        • Adding the widget to Shopify via the Theme editor embed block
    • Localization
    • Customizations
      • Adding a link to your Privacy Policy in Chatbot window
  • Voice Bot
    • Getting Started with Voice Bots
    • Voice Bot Architecture
    • Supported use cases for Voice Bot
    • Setup and Configuration
  • Ticket Automation
    • Setup Zendesk email and ticket automation
  • Guides
    • Building Guides
    • Guide Theme Customization
    • Embedding Guides on your website
    • Embedding Guides in Chatbots
    • How to copy Guides across sites
  • Conversational Flow Builder
    • What is the Conversation Flow Builder?
    • Assign Parameters in Conversations
      • Predefined Parameters
    • How to use Rules in Conversations
    • Conversation Blocks
      • Question
      • Salesforce Blocks
        • Agent Availability Block
        • Live Agent Handover
      • Guide Blocks
        • Guide Step (Guide Flow)
        • Solved Block
        • Unsolved Block
        • Guide (Chatbot)
      • HTTP Request
      • Client Events
      • Policy
      • Zendesk Sunshine Conversations Handoff (In Widget)
    • Data Tables
      • How to read or search data from Data Tables?
  • Analytics
    • Chatbot Analytics
    • Viewing Chat Conversations
    • Message Viewer
    • Integrating with Google Analytics
    • Export API
      • Conversations Endpoint
      • Messages Endpoint
  • Integrations
    • Supported Integrations
      • Zendesk
      • Zendesk Sunshine Conversations
      • Salesforce
      • Gorgias
  • Account
    • Adding Users
    • Permissions and Roles
    • Multiple Sites
  • Security
    • DeepConverse Public IPs
    • Subprocessors
    • Data Request Policy
    • Technical and Organizational Security Measures
    • Reporting Security Vulnerabilities
      • Log4Shell Vulnerability
    • Generative AI - Technical Security Measures
  • Support
    • Contacting Support
    • Service Levels and Response Times
    • Platform Stability
Powered by GitBook
On this page

Was this helpful?

  1. Analytics
  2. Export API

Conversations Endpoint

The Conversations endpoint returns data about the Conversations your bot has with your customers. Conversation data includes the following fields.

Conversation ID (_id)

Unique id for the conversation

Start Time (startTime)

The conversation's start time.

Last conversation action time (lastActionAt)

The time of last conversation update.

Locale (locale)

Locale of the conversation

Tags (tags)

List of the tags added to the conversation such as resolved, informed, liveChat etc.

Metadata (metadata)

All the metadata stored as part of the conversation. This will include system and user set parameters

Here is a sample request for the conversations endpoint

```python
import requests

url = "https://api.converseapps.com/conversations/export/v1/conversations"

params={
  'start_time': 1696118400,
  'end_time': 1696550400,
  'bot_name': 'r3-218210',
  'per_page': 1000
}
headers = {
  'x-api-key': '<api_key>',
}

response = requests.get(url, headers=headers, params=params)
print(response.json())
```

To iterate through the results pass the cursor value till the cursor returned by the API is null

PreviousExport APINextMessages Endpoint

Last updated 1 year ago

Was this helpful?