Conviva APIs
Welcome to Conviva's developer documentation for APIs.
Conviva APIs provide programmatic access to real-time and historical data visualized in the Conviva Pulse web portal. You can use these APIs to build custom dashboards, extract data for warehouse purposes, or ingest data into third-party tools. Conviva APIs can be easily integrated into the applications and provide HTTP response codes to indicate API errors.
Conviva provides the following API User Guides for quick overviews and concepts, along with the request and response examples.
VSI API Guides
Access limits for Conviva APIs, per minute for each c3 account. Rate limits are based on the number of requests and applied filters. A 500 concurrent request limit is reached with either 100 requests with 5 filters or 500 requests with 1 filter.
| API Type | Endpoint | Access Limits |
|---|---|---|
| Global | all API endpoints | 3000 requests per 5 minutes per IP address |
| V3 Real-Time Metrics | /insights/3.0/real-time-metrics | 500 concurrent requests |
| V3 Historical Metrics |
/insights/3.0/metrics |
400 concurrent requests (Shared across historical metric V3 and Sessions V3 calls) |
| V3 Sessions |
/insights/3.0/sessions/* |
400 concurrent requests (Shared across historical metric V3 and Sessions V3 calls) |
Conviva API accepts only client-based credentials. Generate API credentials in the Pulse API Management page.
Note: Do not use Pulse user-based credentials for any API request. For any questions contact to Conviva Support (support@conviva.com).