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.
VSI APIs
DPI APIs
Access Limits
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. |
| Real-Time Metrics v3 | /insights/3.0/real-time-metrics | 500 concurrent requests. |
| Historical Metrics v3 |
/insights/3.0/metrics |
400 concurrent requests (Shared across historical metric V3 and Sessions V3 calls). |
| Sessions v3 |
/insights/3.0/sessions/* |
400 concurrent requests (Shared across historical metric V3 and Sessions V3 calls). |
| Precision Policy API |
/precision/v1.*/policies/activate /precision/v1.*/policies/reorder |
40 concurrent requests per c3 account per minute up to 160 requests per hour. |
Authentication
To access any Conviva APIs, it is required to provide an API key (client-Id and client-secret). Generate the credentials from the Pulse API Management page.
While calling the Flow API, always use the generated client-Id and client-secret.
Note: Do not use Pulse user-based credentials for any API request. Pulse user-based credentials and Conviva API keys are different. Calling any Conviva APIs with Pulse user-based credentials results in unrecognized credentials and authentication failure.
For any questions contact to Conviva Support (support@conviva.com).
Deleting Historical Resource Data
Contact Conviva Support for resource deletion requests to remove resources from data in Trends dimension tables and other data displays.
After a resource is deleted from an account, the resource name may still appear in the related dimension tables and other data displays if any sessions with the resource were long sessions that started before the resource deletion.