APIs

Blog posts about APIs that we make available or use for SEO purposes

View all categories

Enable AI Overview Tracking in SERPs and Keyword Ranking API

APIs

Laurence O'Toole

Enhanced SERPs API: Complete AI Overview Data Integration Guide

October 28, 2024

•

5 minutes

Authoritas has enhanced its SERPs API to provide comprehensive AI Overview (AIO) support, enabling developers and technical SEOs to programmatically access and analyze AIO data with unprecedented detail. The updated API goes beyond simple detection, capturing the complete AIO ecosystem within search results. With new JSON objects for AIO data, support for multiple result types, and sophisticated positioning tracking, developers can now access everything from generative triggers to follow-up questions. Learn how to implement these new features and optimize your AIO tracking capabilities.

A comprehensive SEO software platform, data, tools and APIs for SEO teams optimising leading eCommerce sites.

// Initialize dataLayer window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} // Set initial banner state if(localStorage.getItem('consentMode') === null) { document.documentElement.style.setProperty('--cookie-banner-display', 'block'); // Delay showing banner for smooth transition setTimeout(() => { document.documentElement.style.setProperty('--cookie-banner-opacity', '1'); }, 100); gtag('consent', 'default', { 'ad_storage': 'denied', 'ad_user_data': 'denied', 'ad_personalization': 'denied', 'analytics_storage': 'denied', 'personalization_storage': 'denied', 'security_storage': 'denied', 'functionality_storage': 'denied', }); gtag('set', 'ads_data_redaction', false); } else { document.documentElement.style.setProperty('--cookie-banner-display', 'none'); document.documentElement.style.setProperty('--cookie-banner-opacity', '0'); gtag('consent', 'default', JSON.parse(localStorage.getItem('consentMode'))); } // Cookie icon click handler document.getElementById('cookie-icon').addEventListener('click', function() { setConsentCheckboxes(); hideOptions(); document.documentElement.style.setProperty('--cookie-banner-display', 'block'); setTimeout(() => { document.documentElement.style.setProperty('--cookie-banner-opacity', '1'); }, 10); }); // Hide banner function function hideBanner() { document.documentElement.style.setProperty('--cookie-banner-opacity', '0'); setTimeout(() => { document.documentElement.style.setProperty('--cookie-banner-display', 'none'); }, 300); } // Hide options function function hideOptions() { document.getElementById('cookie-options').style.height = '0px'; } // Consent checkbox handling function setConsentCheckboxes() { uncheckAllConsentCheckboxes(); const consentModeString = localStorage.getItem('consentMode'); if (consentModeString) { const consentMode = JSON.parse(consentModeString); const consentMapping = { 'functionality_storage': 'consent-necessary', 'ad_storage': 'consent-ad-marketing', 'analytics_storage': 'consent-analytics', 'ad_user_data': 'consent-ad-user', 'ad_personalization': 'consent-ad-personalization', 'personalization_storage': 'consent-personalization', 'security_storage': 'consent-security', }; Object.entries(consentMapping).forEach(([storageKey, checkboxId]) => { const checkbox = document.getElementById(checkboxId); if (checkbox) { const isChecked = consentMode[storageKey] === 'granted'; checkbox.checked = isChecked; const checkboxDiv = checkbox.previousElementSibling; if (checkboxDiv) { checkboxDiv.classList[isChecked ? 'add' : 'remove']('w--redirected-checked'); } } }); } } function uncheckAllConsentCheckboxes() { ['consent-analytics', 'consent-ad-personalization', 'consent-ad-marketing', 'consent-ad-user', 'consent-personalization', 'consent-security'].forEach(checkboxId => { const checkbox = document.getElementById(checkboxId); if (checkbox) { checkbox.checked = false; const checkboxDiv = checkbox.previousElementSibling; if (checkboxDiv?.classList.contains('w--redirected-checked')) { checkboxDiv.classList.remove('w--redirected-checked'); } } }); } // Button event listeners document.getElementById('btn-accept-all').addEventListener('click', function() { setConsent({ necessary: true, analytics: true, adpersonalized: true, admarketing: true, aduser: true, personalized: true, security: true, }); hideBanner(); }); document.getElementById('btn-accept-some').addEventListener('click', function() { setConsent({ necessary: true, analytics: document.getElementById('consent-analytics').checked, adpersonalized: document.getElementById('consent-ad-personalization').checked, admarketing: document.getElementById('consent-ad-marketing').checked, aduser: document.getElementById('consent-ad-user').checked, personalized: document.getElementById('consent-personalization').checked, security: document.getElementById('consent-security').checked, }); hideBanner(); }); document.getElementById('btn-reject-all').addEventListener('click', function() { setConsent({ necessary: true, analytics: false, adpersonalized: false, admarketing: false, aduser: false, personalized: false, security: false }); hideBanner(); }); // Set consent function function setConsent(consent) { const consentMode = { 'functionality_storage': consent.necessary ? 'granted' : 'denied', 'ad_user_data': consent.aduser ? 'granted' : 'denied', 'ad_storage': consent.admarketing ? 'granted' : 'denied', 'analytics_storage': consent.analytics ? 'granted' : 'denied', 'ad_personalization': consent.adpersonalized ? 'granted' : 'denied', 'personalization_storage': consent.personalized ? 'granted' : 'denied', 'security_storage': consent.security ? 'granted' : 'denied', }; gtag('consent', 'update', consentMode); localStorage.setItem('consentMode', JSON.stringify(consentMode)); }

APIs

Related articles

Enhanced SERPs API: Complete AI Overview Data Integration Guide