Conviva Connect
Welcome to the Conviva APIs and data to guide you through Conviva Connect, Conviva API implementation, and Session Source Data (SSD).
Conviva Connect
Conviva Connect enables scheduled delivery of Conviva data, including content and ad session-level information for every video play or attempted play in a given day. It also allows to choose traffic rule accounts for content session data pipelines. To enable Conviva Connect, reach out to your Conviva representative or contact Conviva Support.
-
Content Summary
-
SPI Calculation based on Content Summary
-
Content Summary (Parquet)
-
Ad Summary
-
Identity Summary
Conviva APIs
Conviva APIs provide programmatic access to the real-time and historical data visualized in the Conviva Pulse web portal. You can use this interface to build custom dashboards, extract data for warehouse purposes, or ingest data into third-party tools. These APIs can be easily integrated into your applications and provide HTTP response codes to indicate API errors.
VSI APIs:
-
Metrics V3 API
-
Sessions V3 API
-
Bulk Filters API
-
AI Alerts API
-
Precision Policy API
-
PII Opt-Out API
Scheduled for Decommission on March 31, 2024:
Metrics V2 (Migrate to Metrics V3. See Migrating from Metrics V2 to Metrics V3 API on the developer.conviva.com site.)
Sessions V2 (Migrate to Sessions V3.)
Viewer Module (Migrate to Sessions V3.)
Note: Conviva's Metrics V2, Sessions V2, and Viewers Module APIs are planned for deprecation on March 31, 2024. If you're using these V2 APIs, we recommend you migration to the V3 APIs to take advantage of the new capabilities. Note that the AI Alerts, Bulk Filters, Precision Policy, and PII Opt-OutAPIs are not part of this migration. For migration details for the Metrics API, see Migrating from Metrics V2 to Metrics V3 API on the developer.conviva.com site.
Access Limits for Conviva APIs. 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 | Endpoint | Access Limit |
---|---|---|
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 per c3 account per minute |
Historical Metrics V3 | /insights/3.0/metrics | 400 concurrent requests per c3 account per minute (Shared) |
Sessions V3 | /insights/3.0/sessions/* | |
Sessions V2 | /insights/2.*/sessions/* | |
Viewer Module V2 | /insights/2.*/viewer/metrics
|
|
Real-Time Metrics V2 | /insights/2.*/metrics.json | 100 concurrent requests per c3 account per minute (requests with 5 filters, max 500 filter-requests per minute) |
Metrics V2 | /insights/2.*/metrics.json | 64 concurrent requests per c3 account per minute (requests with 5 filters, max 320 filter-requests per minute) |
Precision Policy API | POST /precision/v1.*/policies/activate |
40 concurrent requests per c3 account per minute up to 160 requests per hour |
Precision Policy API | POST /precision/v1.*/policies/reorder | 40 concurrent requests per c3 account per minute up to 160 requests per hour |
Note: If the access limit is exceeded, API servers throttle the requests and return HTTP 429 Too Many Requests error response.
For more information about rate plans, please contact your Conviva representative.
For Conviva application API User and Reference Guides, refer to developer.conviva.com.
Additional API guides:
Session Source Data (SSD)
SSD is a daily offline historical log that provides session-level information for every video play or attempted play in a given day.
- Session Source Data
- Session Source Data (Parquet)
- Ads Session Source Data
API Rate Limits Access Limits API Rate Limits