<p>This section lists the release notes for the recent API releases.</p>
<h3 id="ConvivaAPIs" data-magellan-target="ConvivaAPIs">Conviva APIs</h3>
<div class="MCDropDown MCDropDown_Closed dropDown"><span class="MCDropDownHead dropDownHead"><a href="#" class="MCDropDownHotSpot dropDownHotspot MCDropDownHotSpot_ MCHotSpotImage" aria-expanded="false"><img class="MCDropDown_Image_Icon" src="/resources/images/Skins/Default/Stylesheets/Images/transparent.gif" alt="Closed" data-mc-alt2="Open" />API Summary 2024</a></span>
<div class="MCDropDownBody dropDownBody">
<table style="mc-table-style: url('../resources/stylesheets/tablestyles/basic.css');border-left-style: none;border-right-style: none;border-top-style: none;border-bottom-style: none;margin-left: 0;margin-right: auto;" class="TableStyle-basic" cellspacing="0">
<col class="TableStyle-basic-Column-Column1" style="width: 399px;" />
<col class="TableStyle-basic-Column-Column1" style="width: 399px;" />
<col class="TableStyle-basic-Column-Column1" style="width: 399px;" />
<tbody>
<tr class="TableStyle-basic-Body-Body1">
<td style="vertical-align: top;" class="TableStyle-basic-BodyE-Column1-Body1">
<p><b>Metrics V3 API</b>
</p>
<p>Retrieves historical and real-time metrics for building custom dashboards or applications.</p>
<p><a href="#March272024">March 27, 2024</a>
</p>
</td>
<td style="vertical-align: top;" class="TableStyle-basic-BodyE-Column1-Body1">
<p><b> Session V3 API</b>
</p>
<p>Retrieves viewer experience by combining statuses, metrics, and dimensional metadata.</p>
<p><a href="#May232024">May 23, 2024</a>
</p>
<p><a href="#March272024">March 27, 2024</a>
</p>
</td>
<td style="vertical-align: top;" class="TableStyle-basic-BodyD-Column1-Body1">
<p><b>Bulk Filters API</b>
</p>
<p>Manages saved filter settings via API, allowing retrieval, modification, creation, and deletion of filters.</p>
</td>
</tr>
<tr class="TableStyle-basic-Body-Body1">
<td style="vertical-align: top;" class="TableStyle-basic-BodyB-Column1-Body1">
<p><b>AI Alerts API</b>
</p>
<p>Determines the impact of impact of the alert condition based on the given severity level. </p>
</td>
<td style="vertical-align: top;" class="TableStyle-basic-BodyB-Column1-Body1">
<p><b>Precision Policy API</b>
</p>
<p>Manages Precision filters and policies, activating one or more and rearranging filters.</p>
</td>
<td style="vertical-align: top;" class="TableStyle-basic-BodyA-Column1-Body1">
<p><b>PII Opt-Out API</b>
</p>
<p>Removes Personally Identifiable Information (PII) data using viewer IDs,and view PII request status.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="whats_new">
<h4>2024 Releases</h4>
<h4 class="IncludeInTOC" id="May232024" data-magellan-target="May232024"><b>May 23, 2024</b>
</h4>
<ul>
<li>
<p><b>Sessions V3 API:</b> </p>
<ul>
<li>
<p>Allows <code>?Limit={N}</code> in the query parameter to control the number of sessions in the response.</p>
</li>
<li>
<p>Displays <b>IP</b> and <b>IPv6</b> information in the <code>network_info</code> section of the API response.</p>
</li>
</ul>
<p><b>More Details:</b> <a href="apis/conviva_vsi_api/sessions_v3_api.htm" target="_blank">Sessions V3 API</a></p>
</li>
</ul>
<h4 class="IncludeInTOC" id="March312024" data-magellan-target="March312024"><b>March 31, 2024</b>
</h4>
<ul>
<li>
<p><b>Conviva's Metrics V2 API</b>, <b>Sessions V2 API</b>, and <b>Viewers Module API:</b> </p>
<ul>
<li>
<p>The V2 APIs are deprecated. Use the V3 version of these APIs to take advantage of the new capabilities. The <b>AI Alerts API</b>, <b>Precision Policy API</b>, and <b>PII Opt-Out API</b> are not part of this migration.</p>
</li>
</ul>
<p><b>More Details:</b> <a href="apis/conviva_vsi_api/metrics_v3_api_guide.htm">Metrics V3 API</a> and <a href="apis/conviva_vsi_api/sessions_v3_api.htm">Sessions V3 API</a></p>
</li>
</ul>
<h4 class="IncludeInTOC" id="March272024" data-magellan-target="March272024"><b>March 27, 2024</b>
</h4>
<ul>
<li>
<p><b>Metrics V3 API</b> and <b>Sessions V3 API: </b> </p>
<ul>
<li>
<p>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.</p>
</li>
</ul>
<p><b>More Details:</b> <a href="apis/conviva_vsi_api/metrics_v3_api_guide.htm">Metrics V3 API</a> and <a href="apis/conviva_vsi_api/sessions_v3_api.htm">Sessions V3 API</a></p>
</li>
</ul>
</div>
What's New in Conviva APIs
This section lists the release notes for the recent API releases.