Converz Data API (1.0.5)

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

Overview

Use this API to:

• List, export, and update users and their attributes
• List, export, and update conversations with metadata and analytics
• Retrieve analytics that aggregate metrics across time, users, vendors, campaigns and more

Typical use cases:

• Load Converz data (like automatically generated summaries) into your data warehouse or CRM
• Build custom dashboards for operations / team leads
• Enrich internal tools with conversation and user metrics

Core concepts

• user – a support agent / user in your Converz environment (identified by rep_id)
• conversation – a single customer interaction with metadata, timing and analytics (identified by call_id)
• analytics – aggregated metrics over conversations and/or in-app user activity

Base URL

All endpoints are served under:

https://yourdomain.converz.co/api/v1

Authentication

All requests must be authenticated. Include your API key in every request header, for example:

X-API-Key: YOUR_API_KEY

Replace YOUR_API_KEY with a valid key for your environment. Keys are provisioned by Converz.

Getting started

1. Obtain an API key from your Converz contact.
2. Make a test request to GET /reps?n_per_page=1 to verify connectivity (lists users).
3. Use GET /calls to fetch conversation-level data for your desired period.
4. Use GET /report to retrieve analytics over conversations and/or users.

Which endpoints should I use?

For most integrations, use the JSON, row-based endpoints:

• GET /reps – primary listing endpoint for users
• GET /calls – primary listing endpoint for conversations
• GET /report – primary endpoint for aggregated analytics