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.

Video API Guides

• Efficient API Usage (batch, group-by, cache settled windows, and avoid HTTP 429)

• Metrics V3 API

• Sessions V3 API

• Bulk Filters API

• AI Alerts API

• Precision Policy API

• PII Opt-Out API

Access limits are enforced per c3 account as queries per minute (QPM). Analytical limits are shared across Historical Metrics V3 and Sessions V3. For the current per-endpoint values, see the Rate Limits section of the Metrics V3 API Guide, the single source of truth for Conviva Video API rate limits. For full contractual limits and rate plans, see the Conviva service description.

Conviva API accepts only client-based credentials. Generate API credentials in the Pulse API Management page.