What's New in Conviva APIs

This section lists the release notes for the recent API releases.

Conviva APIs

API Summary 2024

Metrics V3 API

Retrieves historical and real-time metrics for building custom dashboards or applications.

Session V3 API

Retrieves viewer experience by combining statuses, metrics, and dimensional metadata.

Bulk Filters API

Manages saved filter settings via API, allowing retrieval, modification, creation, and deletion of filters.

AI Alerts API

Determines the impact of impact of the alert condition based on the given severity level.

Precision Policy API

Manages Precision filters and policies, activating one or more and rearranging filters.

PII Opt-Out API

Removes Personally Identifiable Information (PII) data using viewer IDs,and view PII request status.

Sessions V3 API:
- Allows ?Limit={N} in the query parameter to control the number of sessions in the response.
- Displays IP and IPv6 information in the network_info section of the API response.
More Details: Sessions V3 API

Conviva's Metrics V2 API, Sessions V2 API, and Viewers Module API:
- The V2 APIs are deprecated. Use the V3 version of these APIs to take advantage of the new capabilities. The AI Alerts API, Precision Policy API, and PII Opt-Out API are not part of this migration.
More Details: Metrics V3 API and Sessions V3 API

Metrics V3 API and Sessions V3 API:
- Improves to retrieve metrics and viewer sessions based on a given time range. The default time range will no more be effective for retrieving the historical metrics and session data.
More Details: Metrics V3 API and Sessions V3 API