diff --git a/docs/index.html b/docs/index.html
index 6d34e6e6..29d58694 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -487,7 +487,7 @@
           55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
           -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
           -104.0616 -231.873,-231.248 z
-        " fill="currentColor"></path></g></svg></div></div><div class="sc-dJwLKM egesOz api-content"><div class="sc-dDvxFM dTJVET"><div class="sc-kuACkN eXZVyu"><div class="sc-gaZyOd kqlrlV api-info"><h1 class="sc-hWWBcw sc-jSWXVd gJBEDr kfgFKP">SpaceCat API<!-- --> <span>(<!-- -->1.89.15<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:</p><div class="sc-dODueM sc-eHKghg fhLETC hIcgHh"><div class="sc-fJoByQ hPmnue"><div class="sc-jYGMYt gjRwVX"> <span class="sc-klyrMv jmbjdV">URL: <a href="https://github.com/adobe/spacecat-api-service">https://github.com/adobe/spacecat-api-service</a></span> <span class="sc-klyrMv jmbjdV">License:<!-- --> <a href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache 2.0</a></span> <span class="sc-klyrMv jmbjdV"><a href="https://www.adobe.com/go/experiencecloudterms">Terms of Service</a></span></div></div></div><div data-role="redoc-summary" html="" class="sc-dODueM sc-eHKghg fhLETC hIcgHh"></div><div data-role="redoc-description" html="&lt;p&gt;The SpaceCat API is used to manage edge delivery site directory and obtain audit information.&lt;/p&gt;
+        " fill="currentColor"></path></g></svg></div></div><div class="sc-dJwLKM egesOz api-content"><div class="sc-dDvxFM dTJVET"><div class="sc-kuACkN eXZVyu"><div class="sc-gaZyOd kqlrlV api-info"><h1 class="sc-hWWBcw sc-jSWXVd gJBEDr kfgFKP">SpaceCat API<!-- --> <span>(<!-- -->1.90.0<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:</p><div class="sc-dODueM sc-eHKghg fhLETC hIcgHh"><div class="sc-fJoByQ hPmnue"><div class="sc-jYGMYt gjRwVX"> <span class="sc-klyrMv jmbjdV">URL: <a href="https://github.com/adobe/spacecat-api-service">https://github.com/adobe/spacecat-api-service</a></span> <span class="sc-klyrMv jmbjdV">License:<!-- --> <a href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache 2.0</a></span> <span class="sc-klyrMv jmbjdV"><a href="https://www.adobe.com/go/experiencecloudterms">Terms of Service</a></span></div></div></div><div data-role="redoc-summary" html="" class="sc-dODueM sc-eHKghg fhLETC hIcgHh"></div><div data-role="redoc-description" html="&lt;p&gt;The SpaceCat API is used to manage edge delivery site directory and obtain audit information.&lt;/p&gt;
 " class="sc-dODueM sc-eHKghg fhLETC hIcgHh"><p>The SpaceCat API is used to manage edge delivery site directory and obtain audit information.</p>
 </div></div></div></div><div id="section/Authentication" data-section-id="section/Authentication" class="sc-dDvxFM dTJVET"><div class="sc-kuACkN eXZVyu"><div class="sc-gaZyOd kqlrlV"><h2 class="sc-cGXZpB eqtXef"><a class="sc-jMLmsk ENkuP" href="#section/Authentication" aria-label="section/Authentication"></a>Authentication</h2></div></div><div id="section/Authentication/api_key" data-section-id="section/Authentication/api_key" class="sc-dDvxFM dTJVET"><div class="sc-kuACkN eXZVyu"><div class="sc-gaZyOd kqlrlV"><h2 class="sc-jHbxoU hKnwYv"><a class="sc-jMLmsk ENkuP" href="#section/Authentication/api_key" aria-label="section/Authentication/api_key"></a>api_key</h2><div html="&lt;p&gt;DEPRECATED, use scoped_api_key or ims_key. (Used for read-only operations.)&lt;/p&gt;
 " class="sc-dODueM sc-eHKghg fhLETC hIcgHh"><p>DEPRECATED, use scoped_api_key or ims_key. (Used for read-only operations.)</p>
@@ -847,7 +847,7 @@
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>The site ID in uuid format</p>
 </div></div></div></td></tr><tr class=""><td kind="field" title="source" class="sc-ldgYGE sc-efgocT kjmvfQ gQnAKZ"><span class="sc-gztard bRicla"></span><span class="property-name">source</span><div class="sc-mLnbr sc-hXGFlK hPYYRX gKRDZM">required</div></td><td class="sc-ffiKcS iOAozH"><div><div><span class="sc-mLnbr sc-cGjkqA hPYYRX bMbGNb"></span><span class="sc-mLnbr sc-gVBvQd hPYYRX cJfKTo">string</span></div><div><span class="sc-mLnbr hPYYRX"> <!-- -->Value<!-- -->:</span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">&quot;ahrefs&quot;</span> </div> <div><span class="sc-mLnbr hPYYRX"> <!-- -->Example:<!-- --> </span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">ahrefs</span></div><div><div html="&lt;p&gt;The source of the top pages&lt;/p&gt;
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>The source of the top pages</p>
-</div></div></div></td></tr><tr class="last "><td kind="field" title="metric" class="sc-ldgYGE sc-efgocT kjmvfQ gQnAKZ"><span class="sc-gztard bRicla"></span><span class="property-name">metric</span><div class="sc-mLnbr sc-hXGFlK hPYYRX gKRDZM">required</div></td><td class="sc-ffiKcS iOAozH"><div><div><span class="sc-mLnbr sc-cGjkqA hPYYRX bMbGNb"></span><span class="sc-mLnbr sc-gVBvQd hPYYRX cJfKTo">string</span></div><div><span class="sc-mLnbr hPYYRX"> <!-- -->Value<!-- -->:</span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">&quot;organic-traffic&quot;</span> </div> <div><span class="sc-mLnbr hPYYRX"> <!-- -->Example:<!-- --> </span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">organic-traffic</span></div><div><div html="&lt;p&gt;The name of the site metric&lt;/p&gt;
+</div></div></div></td></tr><tr class="last "><td kind="field" title="metric" class="sc-ldgYGE sc-efgocT kjmvfQ gQnAKZ"><span class="sc-gztard bRicla"></span><span class="property-name">metric</span><div class="sc-mLnbr sc-hXGFlK hPYYRX gKRDZM">required</div></td><td class="sc-ffiKcS iOAozH"><div><div><span class="sc-mLnbr sc-cGjkqA hPYYRX bMbGNb"></span><span class="sc-mLnbr sc-gVBvQd hPYYRX cJfKTo">string</span></div><div><span class="sc-mLnbr hPYYRX"> <!-- -->Enum<!-- -->:</span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">&quot;organic-traffic&quot;</span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">&quot;organic-keywords&quot;</span> </div> <div><span class="sc-mLnbr hPYYRX"> <!-- -->Example:<!-- --> </span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">organic-traffic</span></div><div><div html="&lt;p&gt;The name of the site metric&lt;/p&gt;
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>The name of the site metric</p>
 </div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fGPuXZ bjVypQ">Responses</h3><div><button class="sc-jOBbTA cYXNfJ"><svg class="sc-cMHOsR fIBTiR" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dCIkRk inLVnQ">200<!-- --> </strong><div html="&lt;p&gt;A list of site metrics&lt;/p&gt;
 " class="sc-dODueM sc-eHKghg sc-enuJcz fhLETC dUWOA-D ibumEn"><p>A list of site metrics</p>
@@ -863,13 +863,15 @@
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>Development server</p>
 </div><div tabindex="0" role="button"><div class="sc-lmtMCX cTezXR"><span>https://spacecat.experiencecloud.live/api/ci</span>/sites/{siteId}/metrics/{metric}/{source}</div></div></div><div class="sc-hNMcCY bZMqjD"><div html="&lt;p&gt;Production server&lt;/p&gt;
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>Production server</p>
-</div><div tabindex="0" role="button"><div class="sc-lmtMCX cTezXR"><span>https://spacecat.experiencecloud.live/api/v1</span>/sites/{siteId}/metrics/{metric}/{source}</div></div></div></div></div><div><h3 class="sc-jZCRgm dKfWLZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-bHCmUC eKwgKS" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj51a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj51a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj51a:0" aria-labelledby="tab:Rjj51a:0"><div><div class="sc-bCFcQi OizcY"><span class="sc-fzvUyt btjQAM">Content type</span><div class="sc-bkdIYQ ipwpEI">application/json</div></div><div class="sc-ljFCIV ldAlKZ"><div class="sc-fdNlyR dmQZei"><div class="sc-kYYDBl jsYwEy"><button><div class="sc-fnxfcy bpcrOQ">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-dODueM fhLETC sc-gdPHyQ hTzIMC"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"siteId"</span>: <span class="token string">&quot;a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"source"</span>: <span class="token string">&quot;ahrefs&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">&quot;organic-traffic&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token number">37900</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"time"</span>: <span class="token string">&quot;2024-04-29T00:00:00.000Z&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/site/operation/getPageMetricsBySource" data-section-id="tag/site/operation/getPageMetricsBySource" class="sc-dDvxFM iYfDfc"><div data-section-id="operation/getPageMetricsBySource" id="operation/getPageMetricsBySource" class="sc-kuACkN eXZVyu"><div class="sc-gaZyOd kqlrlV"><h2 class="sc-jHbxoU hKnwYv"><a class="sc-jMLmsk ENkuP" href="#tag/site/operation/getPageMetricsBySource" aria-label="tag/site/operation/getPageMetricsBySource"></a>Retrieve page metrics by source<!-- --> </h2><div class="sc-bFVjpq bPMJNO"><div html="&lt;p&gt;This endpoint is useful for retrieving page metrics by source&lt;/p&gt;
-" class="sc-dODueM sc-eHKghg fhLETC hIcgHh"><p>This endpoint is useful for retrieving page metrics by source</p>
+</div><div tabindex="0" role="button"><div class="sc-lmtMCX cTezXR"><span>https://spacecat.experiencecloud.live/api/v1</span>/sites/{siteId}/metrics/{metric}/{source}</div></div></div></div></div><div><h3 class="sc-jZCRgm dKfWLZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-bHCmUC eKwgKS" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj51a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj51a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj51a:0" aria-labelledby="tab:Rjj51a:0"><div><div class="sc-bCFcQi OizcY"><span class="sc-fzvUyt btjQAM">Content type</span><div class="sc-bkdIYQ ipwpEI">application/json</div></div><div class="sc-ljFCIV ldAlKZ"><div class="sc-fdNlyR dmQZei"><div class="sc-kYYDBl jsYwEy"><button><div class="sc-fnxfcy bpcrOQ">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-dODueM fhLETC sc-gdPHyQ hTzIMC"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"siteId"</span>: <span class="token string">&quot;a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"source"</span>: <span class="token string">&quot;ahrefs&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">&quot;organic-traffic&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token number">37900</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"time"</span>: <span class="token string">&quot;2024-04-29T00:00:00.000Z&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/site/operation/getPageMetricsBySource" data-section-id="tag/site/operation/getPageMetricsBySource" class="sc-dDvxFM iYfDfc"><div data-section-id="operation/getPageMetricsBySource" id="operation/getPageMetricsBySource" class="sc-kuACkN eXZVyu"><div class="sc-gaZyOd kqlrlV"><h2 class="sc-jHbxoU hKnwYv"><a class="sc-jMLmsk ENkuP" href="#tag/site/operation/getPageMetricsBySource" aria-label="tag/site/operation/getPageMetricsBySource"></a>Retrieve page metrics by source<!-- --> </h2><div class="sc-bFVjpq bPMJNO"><div html="&lt;p&gt;This endpoint is useful for retrieving page metrics by source.
+Currently only &lt;code&gt;organic-keywords&lt;/code&gt; is supported as a metric.&lt;/p&gt;
+" class="sc-dODueM sc-eHKghg fhLETC hIcgHh"><p>This endpoint is useful for retrieving page metrics by source.
+Currently only <code>organic-keywords</code> is supported as a metric.</p>
 </div></div><div class="sc-jgUYHg gBDWPm"><div class="sc-iGVMzj fniPwu"><h5 class="sc-cZztgT sc-igSCHh fjywuK jOkTAF">Authorizations:</h5><svg class="sc-cMHOsR iZhOXi" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jGYizi khbMg"><span class="sc-jbljDQ ejyGQn"><span class="sc-ibiNDR gUUWdn"><i>api_key</i></span></span></div></div><div><h5 class="sc-cZztgT fjywuK">path<!-- --> Parameters</h5><table class="sc-ekQdgj AJjSv"><tbody><tr class=""><td kind="field" title="siteId" class="sc-ldgYGE sc-efgocT kjmvfQ gQnAKZ"><span class="sc-gztard bRicla"></span><span class="property-name">siteId</span><div class="sc-mLnbr sc-hXGFlK hPYYRX gKRDZM">required</div></td><td class="sc-ffiKcS iOAozH"><div><div><span class="sc-mLnbr sc-cGjkqA hPYYRX bMbGNb"></span><span class="sc-mLnbr sc-gVBvQd hPYYRX cJfKTo">string</span><span class="sc-mLnbr sc-gVBvQd hPYYRX cJfKTo"> <!-- -->&lt;<!-- -->uuid<!-- -->&gt;<!-- --> </span><span class="sc-mLnbr sc-gXEjlL hPYYRX dTkFez"> (<!-- -->Id<!-- -->) </span></div> <div><span class="sc-mLnbr hPYYRX"> <!-- -->Example:<!-- --> </span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">123e4567-e89b-12d3-a456-426614174000</span></div><div><div html="&lt;p&gt;The site ID in uuid format&lt;/p&gt;
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>The site ID in uuid format</p>
 </div></div></div></td></tr><tr class=""><td kind="field" title="source" class="sc-ldgYGE sc-efgocT kjmvfQ gQnAKZ"><span class="sc-gztard bRicla"></span><span class="property-name">source</span><div class="sc-mLnbr sc-hXGFlK hPYYRX gKRDZM">required</div></td><td class="sc-ffiKcS iOAozH"><div><div><span class="sc-mLnbr sc-cGjkqA hPYYRX bMbGNb"></span><span class="sc-mLnbr sc-gVBvQd hPYYRX cJfKTo">string</span></div><div><span class="sc-mLnbr hPYYRX"> <!-- -->Value<!-- -->:</span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">&quot;ahrefs&quot;</span> </div> <div><span class="sc-mLnbr hPYYRX"> <!-- -->Example:<!-- --> </span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">ahrefs</span></div><div><div html="&lt;p&gt;The source of the top pages&lt;/p&gt;
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>The source of the top pages</p>
-</div></div></div></td></tr><tr class=""><td kind="field" title="metric" class="sc-ldgYGE sc-efgocT kjmvfQ gQnAKZ"><span class="sc-gztard bRicla"></span><span class="property-name">metric</span><div class="sc-mLnbr sc-hXGFlK hPYYRX gKRDZM">required</div></td><td class="sc-ffiKcS iOAozH"><div><div><span class="sc-mLnbr sc-cGjkqA hPYYRX bMbGNb"></span><span class="sc-mLnbr sc-gVBvQd hPYYRX cJfKTo">string</span></div><div><span class="sc-mLnbr hPYYRX"> <!-- -->Value<!-- -->:</span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">&quot;organic-traffic&quot;</span> </div> <div><span class="sc-mLnbr hPYYRX"> <!-- -->Example:<!-- --> </span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">organic-traffic</span></div><div><div html="&lt;p&gt;The name of the site metric&lt;/p&gt;
+</div></div></div></td></tr><tr class=""><td kind="field" title="metric" class="sc-ldgYGE sc-efgocT kjmvfQ gQnAKZ"><span class="sc-gztard bRicla"></span><span class="property-name">metric</span><div class="sc-mLnbr sc-hXGFlK hPYYRX gKRDZM">required</div></td><td class="sc-ffiKcS iOAozH"><div><div><span class="sc-mLnbr sc-cGjkqA hPYYRX bMbGNb"></span><span class="sc-mLnbr sc-gVBvQd hPYYRX cJfKTo">string</span></div><div><span class="sc-mLnbr hPYYRX"> <!-- -->Enum<!-- -->:</span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">&quot;organic-traffic&quot;</span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">&quot;organic-keywords&quot;</span> </div> <div><span class="sc-mLnbr hPYYRX"> <!-- -->Example:<!-- --> </span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">organic-traffic</span></div><div><div html="&lt;p&gt;The name of the site metric&lt;/p&gt;
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>The name of the site metric</p>
 </div></div></div></td></tr><tr class="last "><td kind="field" title="base64PageUrl" class="sc-ldgYGE sc-efgocT kjmvfQ gQnAKZ"><span class="sc-gztard bRicla"></span><span class="property-name">base64PageUrl</span><div class="sc-mLnbr sc-hXGFlK hPYYRX gKRDZM">required</div></td><td class="sc-ffiKcS iOAozH"><div><div><span class="sc-mLnbr sc-cGjkqA hPYYRX bMbGNb"></span><span class="sc-mLnbr sc-gVBvQd hPYYRX cJfKTo">string</span><span class="sc-mLnbr sc-gVBvQd hPYYRX cJfKTo"> <!-- -->&lt;<!-- -->base64url<!-- -->&gt;<!-- --> </span></div> <div><div html="&lt;p&gt;Base64-encoded page URL&lt;/p&gt;
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>Base64-encoded page URL</p>
@@ -887,7 +889,7 @@
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>Development server</p>
 </div><div tabindex="0" role="button"><div class="sc-lmtMCX cTezXR"><span>https://spacecat.experiencecloud.live/api/ci</span>/sites/{siteId}/metrics/{metric}/{source}/by-url/{base64PageUrl}</div></div></div><div class="sc-hNMcCY bZMqjD"><div html="&lt;p&gt;Production server&lt;/p&gt;
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>Production server</p>
-</div><div tabindex="0" role="button"><div class="sc-lmtMCX cTezXR"><span>https://spacecat.experiencecloud.live/api/v1</span>/sites/{siteId}/metrics/{metric}/{source}/by-url/{base64PageUrl}</div></div></div></div></div><div><h3 class="sc-jZCRgm dKfWLZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-bHCmUC eKwgKS" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj71a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj71a:0" aria-labelledby="tab:Rjj71a:0"><div><div class="sc-bCFcQi OizcY"><span class="sc-fzvUyt btjQAM">Content type</span><div class="sc-bkdIYQ ipwpEI">application/json</div></div><div class="sc-ljFCIV ldAlKZ"><div class="sc-fdNlyR dmQZei"><div class="sc-kYYDBl jsYwEy"><button><div class="sc-fnxfcy bpcrOQ">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-dODueM fhLETC sc-gdPHyQ hTzIMC"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"siteId"</span>: <span class="token string">&quot;a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"source"</span>: <span class="token string">&quot;ahrefs&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">&quot;organic-traffic&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"time"</span>: <span class="token string">&quot;2024-04-29T00:00:00.000Z&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">&quot;</span><a href="https://example.com/foo/bar">https://example.com/foo/bar</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"keyword"</span>: <span class="token string">&quot;foo bar example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"traffic"</span>: <span class="token string">&quot;2355,&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"volume"</span>: <span class="token string">&quot;2400,&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bestPosition"</span>: <span class="token string">&quot;1,&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cpc"</span>: <span class="token string">&quot;89,&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"isBranded"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/site/operation/getExperiments" data-section-id="tag/site/operation/getExperiments" class="sc-dDvxFM iYfDfc"><div data-section-id="operation/getExperiments" id="operation/getExperiments" class="sc-kuACkN eXZVyu"><div class="sc-gaZyOd kqlrlV"><h2 class="sc-jHbxoU hKnwYv"><a class="sc-jMLmsk ENkuP" href="#tag/site/operation/getExperiments" aria-label="tag/site/operation/getExperiments"></a>Retrieves all experiments for the site<!-- --> </h2><div class="sc-bFVjpq bPMJNO"><div html="&lt;p&gt;This endpoint provide a list of experiments obtained from RUM data for the given site along with all the experiment details.&lt;/p&gt;
+</div><div tabindex="0" role="button"><div class="sc-lmtMCX cTezXR"><span>https://spacecat.experiencecloud.live/api/v1</span>/sites/{siteId}/metrics/{metric}/{source}/by-url/{base64PageUrl}</div></div></div></div></div><div><h3 class="sc-jZCRgm dKfWLZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-bHCmUC eKwgKS" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj71a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj71a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj71a:0" aria-labelledby="tab:Rjj71a:0"><div><div class="sc-bCFcQi OizcY"><span class="sc-fzvUyt btjQAM">Content type</span><div class="sc-bkdIYQ ipwpEI">application/json</div></div><div class="sc-ljFCIV ldAlKZ"><div class="sc-fdNlyR dmQZei"><div class="sc-kYYDBl jsYwEy"><button><div class="sc-fnxfcy bpcrOQ">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-dODueM fhLETC sc-gdPHyQ hTzIMC"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"siteId"</span>: <span class="token string">&quot;a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"source"</span>: <span class="token string">&quot;ahrefs&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">&quot;organic-keywords&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"time"</span>: <span class="token string">&quot;2024-04-29T00:00:00.000Z&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">&quot;</span><a href="https://example.com/foo/bar">https://example.com/foo/bar</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"keyword"</span>: <span class="token string">&quot;foo bar example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"traffic"</span>: <span class="token number">2355</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"volume"</span>: <span class="token number">2400</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bestPosition"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cpc"</span>: <span class="token number">89</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"isBranded"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/site/operation/getExperiments" data-section-id="tag/site/operation/getExperiments" class="sc-dDvxFM iYfDfc"><div data-section-id="operation/getExperiments" id="operation/getExperiments" class="sc-kuACkN eXZVyu"><div class="sc-gaZyOd kqlrlV"><h2 class="sc-jHbxoU hKnwYv"><a class="sc-jMLmsk ENkuP" href="#tag/site/operation/getExperiments" aria-label="tag/site/operation/getExperiments"></a>Retrieves all experiments for the site<!-- --> </h2><div class="sc-bFVjpq bPMJNO"><div html="&lt;p&gt;This endpoint provide a list of experiments obtained from RUM data for the given site along with all the experiment details.&lt;/p&gt;
 " class="sc-dODueM sc-eHKghg fhLETC hIcgHh"><p>This endpoint provide a list of experiments obtained from RUM data for the given site along with all the experiment details.</p>
 </div></div><div class="sc-jgUYHg gBDWPm"><div class="sc-iGVMzj fniPwu"><h5 class="sc-cZztgT sc-igSCHh fjywuK jOkTAF">Authorizations:</h5><svg class="sc-cMHOsR iZhOXi" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jGYizi khbMg"><span class="sc-jbljDQ ejyGQn"><span class="sc-ibiNDR gUUWdn"><i>api_key</i></span></span></div></div><div><h5 class="sc-cZztgT fjywuK">path<!-- --> Parameters</h5><table class="sc-ekQdgj AJjSv"><tbody><tr class="last "><td kind="field" title="siteId" class="sc-ldgYGE sc-efgocT kjmvfQ gQnAKZ"><span class="sc-gztard bRicla"></span><span class="property-name">siteId</span><div class="sc-mLnbr sc-hXGFlK hPYYRX gKRDZM">required</div></td><td class="sc-ffiKcS iOAozH"><div><div><span class="sc-mLnbr sc-cGjkqA hPYYRX bMbGNb"></span><span class="sc-mLnbr sc-gVBvQd hPYYRX cJfKTo">string</span><span class="sc-mLnbr sc-gVBvQd hPYYRX cJfKTo"> <!-- -->&lt;<!-- -->uuid<!-- -->&gt;<!-- --> </span><span class="sc-mLnbr sc-gXEjlL hPYYRX dTkFez"> (<!-- -->Id<!-- -->) </span></div> <div><span class="sc-mLnbr hPYYRX"> <!-- -->Example:<!-- --> </span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">123e4567-e89b-12d3-a456-426614174000</span></div><div><div html="&lt;p&gt;The site ID in uuid format&lt;/p&gt;
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>The site ID in uuid format</p>
@@ -1799,7 +1801,7 @@
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>The site ID in uuid format</p>
 </div></div></div></td></tr><tr class=""><td kind="field" title="source" class="sc-ldgYGE sc-efgocT kjmvfQ gQnAKZ"><span class="sc-gztard bRicla"></span><span class="property-name">source</span><div class="sc-mLnbr sc-hXGFlK hPYYRX gKRDZM">required</div></td><td class="sc-ffiKcS iOAozH"><div><div><span class="sc-mLnbr sc-cGjkqA hPYYRX bMbGNb"></span><span class="sc-mLnbr sc-gVBvQd hPYYRX cJfKTo">string</span></div><div><span class="sc-mLnbr hPYYRX"> <!-- -->Value<!-- -->:</span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">&quot;ahrefs&quot;</span> </div> <div><span class="sc-mLnbr hPYYRX"> <!-- -->Example:<!-- --> </span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">ahrefs</span></div><div><div html="&lt;p&gt;The source of the top pages&lt;/p&gt;
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>The source of the top pages</p>
-</div></div></div></td></tr><tr class="last "><td kind="field" title="metric" class="sc-ldgYGE sc-efgocT kjmvfQ gQnAKZ"><span class="sc-gztard bRicla"></span><span class="property-name">metric</span><div class="sc-mLnbr sc-hXGFlK hPYYRX gKRDZM">required</div></td><td class="sc-ffiKcS iOAozH"><div><div><span class="sc-mLnbr sc-cGjkqA hPYYRX bMbGNb"></span><span class="sc-mLnbr sc-gVBvQd hPYYRX cJfKTo">string</span></div><div><span class="sc-mLnbr hPYYRX"> <!-- -->Value<!-- -->:</span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">&quot;organic-traffic&quot;</span> </div> <div><span class="sc-mLnbr hPYYRX"> <!-- -->Example:<!-- --> </span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">organic-traffic</span></div><div><div html="&lt;p&gt;The name of the site metric&lt;/p&gt;
+</div></div></div></td></tr><tr class="last "><td kind="field" title="metric" class="sc-ldgYGE sc-efgocT kjmvfQ gQnAKZ"><span class="sc-gztard bRicla"></span><span class="property-name">metric</span><div class="sc-mLnbr sc-hXGFlK hPYYRX gKRDZM">required</div></td><td class="sc-ffiKcS iOAozH"><div><div><span class="sc-mLnbr sc-cGjkqA hPYYRX bMbGNb"></span><span class="sc-mLnbr sc-gVBvQd hPYYRX cJfKTo">string</span></div><div><span class="sc-mLnbr hPYYRX"> <!-- -->Enum<!-- -->:</span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">&quot;organic-traffic&quot;</span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">&quot;organic-keywords&quot;</span> </div> <div><span class="sc-mLnbr hPYYRX"> <!-- -->Example:<!-- --> </span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">organic-traffic</span></div><div><div html="&lt;p&gt;The name of the site metric&lt;/p&gt;
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>The name of the site metric</p>
 </div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fGPuXZ bjVypQ">Responses</h3><div><button class="sc-jOBbTA cYXNfJ"><svg class="sc-cMHOsR fIBTiR" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dCIkRk inLVnQ">200<!-- --> </strong><div html="&lt;p&gt;A list of site metrics&lt;/p&gt;
 " class="sc-dODueM sc-eHKghg sc-enuJcz fhLETC dUWOA-D ibumEn"><p>A list of site metrics</p>
@@ -1815,13 +1817,15 @@
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>Development server</p>
 </div><div tabindex="0" role="button"><div class="sc-lmtMCX cTezXR"><span>https://spacecat.experiencecloud.live/api/ci</span>/sites/{siteId}/metrics/{metric}/{source}</div></div></div><div class="sc-hNMcCY bZMqjD"><div html="&lt;p&gt;Production server&lt;/p&gt;
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>Production server</p>
-</div><div tabindex="0" role="button"><div class="sc-lmtMCX cTezXR"><span>https://spacecat.experiencecloud.live/api/v1</span>/sites/{siteId}/metrics/{metric}/{source}</div></div></div></div></div><div><h3 class="sc-jZCRgm dKfWLZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-bHCmUC eKwgKS" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ed6q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ed6q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ed6q:0" aria-labelledby="tab:R2ed6q:0"><div><div class="sc-bCFcQi OizcY"><span class="sc-fzvUyt btjQAM">Content type</span><div class="sc-bkdIYQ ipwpEI">application/json</div></div><div class="sc-ljFCIV ldAlKZ"><div class="sc-fdNlyR dmQZei"><div class="sc-kYYDBl jsYwEy"><button><div class="sc-fnxfcy bpcrOQ">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-dODueM fhLETC sc-gdPHyQ hTzIMC"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"siteId"</span>: <span class="token string">&quot;a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"source"</span>: <span class="token string">&quot;ahrefs&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">&quot;organic-traffic&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token number">37900</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"time"</span>: <span class="token string">&quot;2024-04-29T00:00:00.000Z&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/metrics/operation/getPageMetricsBySource" data-section-id="tag/metrics/operation/getPageMetricsBySource" class="sc-dDvxFM iYfDfc"><div data-section-id="operation/getPageMetricsBySource" id="operation/getPageMetricsBySource" class="sc-kuACkN eXZVyu"><div class="sc-gaZyOd kqlrlV"><h2 class="sc-jHbxoU hKnwYv"><a class="sc-jMLmsk ENkuP" href="#tag/metrics/operation/getPageMetricsBySource" aria-label="tag/metrics/operation/getPageMetricsBySource"></a>Retrieve page metrics by source<!-- --> </h2><div class="sc-bFVjpq bPMJNO"><div html="&lt;p&gt;This endpoint is useful for retrieving page metrics by source&lt;/p&gt;
-" class="sc-dODueM sc-eHKghg fhLETC hIcgHh"><p>This endpoint is useful for retrieving page metrics by source</p>
+</div><div tabindex="0" role="button"><div class="sc-lmtMCX cTezXR"><span>https://spacecat.experiencecloud.live/api/v1</span>/sites/{siteId}/metrics/{metric}/{source}</div></div></div></div></div><div><h3 class="sc-jZCRgm dKfWLZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-bHCmUC eKwgKS" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ed6q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ed6q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ed6q:0" aria-labelledby="tab:R2ed6q:0"><div><div class="sc-bCFcQi OizcY"><span class="sc-fzvUyt btjQAM">Content type</span><div class="sc-bkdIYQ ipwpEI">application/json</div></div><div class="sc-ljFCIV ldAlKZ"><div class="sc-fdNlyR dmQZei"><div class="sc-kYYDBl jsYwEy"><button><div class="sc-fnxfcy bpcrOQ">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-dODueM fhLETC sc-gdPHyQ hTzIMC"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"siteId"</span>: <span class="token string">&quot;a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"source"</span>: <span class="token string">&quot;ahrefs&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">&quot;organic-traffic&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token number">37900</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"time"</span>: <span class="token string">&quot;2024-04-29T00:00:00.000Z&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/metrics/operation/getPageMetricsBySource" data-section-id="tag/metrics/operation/getPageMetricsBySource" class="sc-dDvxFM iYfDfc"><div data-section-id="operation/getPageMetricsBySource" id="operation/getPageMetricsBySource" class="sc-kuACkN eXZVyu"><div class="sc-gaZyOd kqlrlV"><h2 class="sc-jHbxoU hKnwYv"><a class="sc-jMLmsk ENkuP" href="#tag/metrics/operation/getPageMetricsBySource" aria-label="tag/metrics/operation/getPageMetricsBySource"></a>Retrieve page metrics by source<!-- --> </h2><div class="sc-bFVjpq bPMJNO"><div html="&lt;p&gt;This endpoint is useful for retrieving page metrics by source.
+Currently only &lt;code&gt;organic-keywords&lt;/code&gt; is supported as a metric.&lt;/p&gt;
+" class="sc-dODueM sc-eHKghg fhLETC hIcgHh"><p>This endpoint is useful for retrieving page metrics by source.
+Currently only <code>organic-keywords</code> is supported as a metric.</p>
 </div></div><div class="sc-jgUYHg gBDWPm"><div class="sc-iGVMzj fniPwu"><h5 class="sc-cZztgT sc-igSCHh fjywuK jOkTAF">Authorizations:</h5><svg class="sc-cMHOsR iZhOXi" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jGYizi khbMg"><span class="sc-jbljDQ ejyGQn"><span class="sc-ibiNDR gUUWdn"><i>api_key</i></span></span></div></div><div><h5 class="sc-cZztgT fjywuK">path<!-- --> Parameters</h5><table class="sc-ekQdgj AJjSv"><tbody><tr class=""><td kind="field" title="siteId" class="sc-ldgYGE sc-efgocT kjmvfQ gQnAKZ"><span class="sc-gztard bRicla"></span><span class="property-name">siteId</span><div class="sc-mLnbr sc-hXGFlK hPYYRX gKRDZM">required</div></td><td class="sc-ffiKcS iOAozH"><div><div><span class="sc-mLnbr sc-cGjkqA hPYYRX bMbGNb"></span><span class="sc-mLnbr sc-gVBvQd hPYYRX cJfKTo">string</span><span class="sc-mLnbr sc-gVBvQd hPYYRX cJfKTo"> <!-- -->&lt;<!-- -->uuid<!-- -->&gt;<!-- --> </span><span class="sc-mLnbr sc-gXEjlL hPYYRX dTkFez"> (<!-- -->Id<!-- -->) </span></div> <div><span class="sc-mLnbr hPYYRX"> <!-- -->Example:<!-- --> </span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">123e4567-e89b-12d3-a456-426614174000</span></div><div><div html="&lt;p&gt;The site ID in uuid format&lt;/p&gt;
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>The site ID in uuid format</p>
 </div></div></div></td></tr><tr class=""><td kind="field" title="source" class="sc-ldgYGE sc-efgocT kjmvfQ gQnAKZ"><span class="sc-gztard bRicla"></span><span class="property-name">source</span><div class="sc-mLnbr sc-hXGFlK hPYYRX gKRDZM">required</div></td><td class="sc-ffiKcS iOAozH"><div><div><span class="sc-mLnbr sc-cGjkqA hPYYRX bMbGNb"></span><span class="sc-mLnbr sc-gVBvQd hPYYRX cJfKTo">string</span></div><div><span class="sc-mLnbr hPYYRX"> <!-- -->Value<!-- -->:</span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">&quot;ahrefs&quot;</span> </div> <div><span class="sc-mLnbr hPYYRX"> <!-- -->Example:<!-- --> </span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">ahrefs</span></div><div><div html="&lt;p&gt;The source of the top pages&lt;/p&gt;
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>The source of the top pages</p>
-</div></div></div></td></tr><tr class=""><td kind="field" title="metric" class="sc-ldgYGE sc-efgocT kjmvfQ gQnAKZ"><span class="sc-gztard bRicla"></span><span class="property-name">metric</span><div class="sc-mLnbr sc-hXGFlK hPYYRX gKRDZM">required</div></td><td class="sc-ffiKcS iOAozH"><div><div><span class="sc-mLnbr sc-cGjkqA hPYYRX bMbGNb"></span><span class="sc-mLnbr sc-gVBvQd hPYYRX cJfKTo">string</span></div><div><span class="sc-mLnbr hPYYRX"> <!-- -->Value<!-- -->:</span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">&quot;organic-traffic&quot;</span> </div> <div><span class="sc-mLnbr hPYYRX"> <!-- -->Example:<!-- --> </span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">organic-traffic</span></div><div><div html="&lt;p&gt;The name of the site metric&lt;/p&gt;
+</div></div></div></td></tr><tr class=""><td kind="field" title="metric" class="sc-ldgYGE sc-efgocT kjmvfQ gQnAKZ"><span class="sc-gztard bRicla"></span><span class="property-name">metric</span><div class="sc-mLnbr sc-hXGFlK hPYYRX gKRDZM">required</div></td><td class="sc-ffiKcS iOAozH"><div><div><span class="sc-mLnbr sc-cGjkqA hPYYRX bMbGNb"></span><span class="sc-mLnbr sc-gVBvQd hPYYRX cJfKTo">string</span></div><div><span class="sc-mLnbr hPYYRX"> <!-- -->Enum<!-- -->:</span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">&quot;organic-traffic&quot;</span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">&quot;organic-keywords&quot;</span> </div> <div><span class="sc-mLnbr hPYYRX"> <!-- -->Example:<!-- --> </span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">organic-traffic</span></div><div><div html="&lt;p&gt;The name of the site metric&lt;/p&gt;
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>The name of the site metric</p>
 </div></div></div></td></tr><tr class="last "><td kind="field" title="base64PageUrl" class="sc-ldgYGE sc-efgocT kjmvfQ gQnAKZ"><span class="sc-gztard bRicla"></span><span class="property-name">base64PageUrl</span><div class="sc-mLnbr sc-hXGFlK hPYYRX gKRDZM">required</div></td><td class="sc-ffiKcS iOAozH"><div><div><span class="sc-mLnbr sc-cGjkqA hPYYRX bMbGNb"></span><span class="sc-mLnbr sc-gVBvQd hPYYRX cJfKTo">string</span><span class="sc-mLnbr sc-gVBvQd hPYYRX cJfKTo"> <!-- -->&lt;<!-- -->base64url<!-- -->&gt;<!-- --> </span></div> <div><div html="&lt;p&gt;Base64-encoded page URL&lt;/p&gt;
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>Base64-encoded page URL</p>
@@ -1839,7 +1843,7 @@
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>Development server</p>
 </div><div tabindex="0" role="button"><div class="sc-lmtMCX cTezXR"><span>https://spacecat.experiencecloud.live/api/ci</span>/sites/{siteId}/metrics/{metric}/{source}/by-url/{base64PageUrl}</div></div></div><div class="sc-hNMcCY bZMqjD"><div html="&lt;p&gt;Production server&lt;/p&gt;
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>Production server</p>
-</div><div tabindex="0" role="button"><div class="sc-lmtMCX cTezXR"><span>https://spacecat.experiencecloud.live/api/v1</span>/sites/{siteId}/metrics/{metric}/{source}/by-url/{base64PageUrl}</div></div></div></div></div><div><h3 class="sc-jZCRgm dKfWLZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-bHCmUC eKwgKS" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ef6q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ef6q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ef6q:0" aria-labelledby="tab:R2ef6q:0"><div><div class="sc-bCFcQi OizcY"><span class="sc-fzvUyt btjQAM">Content type</span><div class="sc-bkdIYQ ipwpEI">application/json</div></div><div class="sc-ljFCIV ldAlKZ"><div class="sc-fdNlyR dmQZei"><div class="sc-kYYDBl jsYwEy"><button><div class="sc-fnxfcy bpcrOQ">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-dODueM fhLETC sc-gdPHyQ hTzIMC"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"siteId"</span>: <span class="token string">&quot;a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"source"</span>: <span class="token string">&quot;ahrefs&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">&quot;organic-traffic&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"time"</span>: <span class="token string">&quot;2024-04-29T00:00:00.000Z&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">&quot;</span><a href="https://example.com/foo/bar">https://example.com/foo/bar</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"keyword"</span>: <span class="token string">&quot;foo bar example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"traffic"</span>: <span class="token string">&quot;2355,&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"volume"</span>: <span class="token string">&quot;2400,&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bestPosition"</span>: <span class="token string">&quot;1,&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cpc"</span>: <span class="token string">&quot;89,&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"isBranded"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/opportunities" data-section-id="tag/opportunities" class="sc-dDvxFM dTJVET"><div class="sc-kuACkN eXZVyu"><div class="sc-gaZyOd kqlrlV"><h2 class="sc-jHbxoU hKnwYv"><a class="sc-jMLmsk ENkuP" href="#tag/opportunities" aria-label="tag/opportunities"></a>opportunities</h2></div></div></div><div id="tag/opportunities/paths/~1sites~1{siteId}~1opportunities/get" data-section-id="tag/opportunities/paths/~1sites~1{siteId}~1opportunities/get" class="sc-dDvxFM iYfDfc"><div class="sc-kuACkN eXZVyu"><div class="sc-gaZyOd kqlrlV"><h2 class="sc-jHbxoU hKnwYv"><a class="sc-jMLmsk ENkuP" href="#tag/opportunities/paths/~1sites~1{siteId}~1opportunities/get" aria-label="tag/opportunities/paths/~1sites~1{siteId}~1opportunities/get"></a>Retrieve a list of all opportunities for a specific site
+</div><div tabindex="0" role="button"><div class="sc-lmtMCX cTezXR"><span>https://spacecat.experiencecloud.live/api/v1</span>/sites/{siteId}/metrics/{metric}/{source}/by-url/{base64PageUrl}</div></div></div></div></div><div><h3 class="sc-jZCRgm dKfWLZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-bHCmUC eKwgKS" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ef6q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ef6q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ef6q:0" aria-labelledby="tab:R2ef6q:0"><div><div class="sc-bCFcQi OizcY"><span class="sc-fzvUyt btjQAM">Content type</span><div class="sc-bkdIYQ ipwpEI">application/json</div></div><div class="sc-ljFCIV ldAlKZ"><div class="sc-fdNlyR dmQZei"><div class="sc-kYYDBl jsYwEy"><button><div class="sc-fnxfcy bpcrOQ">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-dODueM fhLETC sc-gdPHyQ hTzIMC"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"siteId"</span>: <span class="token string">&quot;a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"source"</span>: <span class="token string">&quot;ahrefs&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">&quot;organic-keywords&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"time"</span>: <span class="token string">&quot;2024-04-29T00:00:00.000Z&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">&quot;</span><a href="https://example.com/foo/bar">https://example.com/foo/bar</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"keyword"</span>: <span class="token string">&quot;foo bar example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"traffic"</span>: <span class="token number">2355</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"volume"</span>: <span class="token number">2400</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bestPosition"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"cpc"</span>: <span class="token number">89</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"isBranded"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/opportunities" data-section-id="tag/opportunities" class="sc-dDvxFM dTJVET"><div class="sc-kuACkN eXZVyu"><div class="sc-gaZyOd kqlrlV"><h2 class="sc-jHbxoU hKnwYv"><a class="sc-jMLmsk ENkuP" href="#tag/opportunities" aria-label="tag/opportunities"></a>opportunities</h2></div></div></div><div id="tag/opportunities/paths/~1sites~1{siteId}~1opportunities/get" data-section-id="tag/opportunities/paths/~1sites~1{siteId}~1opportunities/get" class="sc-dDvxFM iYfDfc"><div class="sc-kuACkN eXZVyu"><div class="sc-gaZyOd kqlrlV"><h2 class="sc-jHbxoU hKnwYv"><a class="sc-jMLmsk ENkuP" href="#tag/opportunities/paths/~1sites~1{siteId}~1opportunities/get" aria-label="tag/opportunities/paths/~1sites~1{siteId}~1opportunities/get"></a>Retrieve a list of all opportunities for a specific site
 <!-- --> </h2><div class="sc-jgUYHg gBDWPm"><div class="sc-iGVMzj fniPwu"><h5 class="sc-cZztgT sc-igSCHh fjywuK jOkTAF">Authorizations:</h5><svg class="sc-cMHOsR iZhOXi" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jGYizi khbMg"><span class="sc-jbljDQ ejyGQn"><span class="sc-ibiNDR gUUWdn"><i>ims_key</i></span></span></div></div><div><h5 class="sc-cZztgT fjywuK">path<!-- --> Parameters</h5><table class="sc-ekQdgj AJjSv"><tbody><tr class="last "><td kind="field" title="siteId" class="sc-ldgYGE sc-efgocT kjmvfQ gQnAKZ"><span class="sc-gztard bRicla"></span><span class="property-name">siteId</span><div class="sc-mLnbr sc-hXGFlK hPYYRX gKRDZM">required</div></td><td class="sc-ffiKcS iOAozH"><div><div><span class="sc-mLnbr sc-cGjkqA hPYYRX bMbGNb"></span><span class="sc-mLnbr sc-gVBvQd hPYYRX cJfKTo">string</span><span class="sc-mLnbr sc-gVBvQd hPYYRX cJfKTo"> <!-- -->&lt;<!-- -->uuid<!-- -->&gt;<!-- --> </span><span class="sc-mLnbr sc-gXEjlL hPYYRX dTkFez"> (<!-- -->Id<!-- -->) </span></div> <div><span class="sc-mLnbr hPYYRX"> <!-- -->Example:<!-- --> </span> <span class="sc-mLnbr sc-csuDXq hPYYRX cktsMe">123e4567-e89b-12d3-a456-426614174000</span></div><div><div html="&lt;p&gt;The site ID in uuid format&lt;/p&gt;
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>The site ID in uuid format</p>
 </div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fGPuXZ bjVypQ">Responses</h3><div><button class="sc-jOBbTA cYXNfJ"><svg class="sc-cMHOsR fIBTiR" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dCIkRk inLVnQ">200<!-- --> </strong><div html="&lt;p&gt;A list of opportunities&lt;/p&gt;
@@ -2332,7 +2336,7 @@
 " class="sc-dODueM sc-eHKghg fhLETC jlTrDX"><p>Production server</p>
 </div><div tabindex="0" role="button"><div class="sc-lmtMCX cTezXR"><span>https://spacecat.experiencecloud.live/api/v1</span>/sites/{siteId}/experiments</div></div></div></div></div><div><h3 class="sc-jZCRgm dKfWLZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-bHCmUC eKwgKS" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R1779a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1779a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1779a:0" aria-labelledby="tab:R1779a:0"><div><div class="sc-bCFcQi OizcY"><span class="sc-fzvUyt btjQAM">Content type</span><div class="sc-bkdIYQ ipwpEI">application/json</div></div><div class="sc-ljFCIV ldAlKZ"><div class="sc-fdNlyR dmQZei"><div class="sc-kYYDBl jsYwEy"><button><div class="sc-fnxfcy bpcrOQ">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-dODueM fhLETC sc-gdPHyQ hTzIMC"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"siteId"</span>: <span class="token string">&quot;a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"experimentId"</span>: <span class="token string">&quot;1012-home-page-optimization&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">&quot;1012 Home Page Optimization&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">&quot;</span><a href="https://example-site.com/foo/bar">https://example-site.com/foo/bar</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">&quot;AB&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">&quot;ACTIVE&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"startDate"</span>: <span class="token string">&quot;2024-04-29T15:14:33.653Z&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"endDate"</span>: <span class="token string">&quot;2024-05-29T15:14:33.653Z&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"variants"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">&quot;challenger-1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"label"</span>: <span class="token string">&quot;Challenger 1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"split"</span>: <span class="token number">0.5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">&quot;</span><a href="https://example-site.com/foo/bar">https://example-site.com/foo/bar</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"views"</span>: <span class="token number">1000</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"samples"</span>: <span class="token number">10</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"interactionsCount"</span>: <span class="token number">200</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"p_value"</span>: <span class="token number">0.04</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"power"</span>: <span class="token number">97.6</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"statsig"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metrics"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"selector"</span>: <span class="token string">&quot;.add-to-cart&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token number">300</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"samples"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">&quot;click&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updatedAt"</span>: <span class="token string">&quot;2024-05-31T15:14:33.653Z&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updatedBy"</span>: <span class="token string">&quot;admin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"conversionEventName"</span>: <span class="token string">&quot;click&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"conversionEventValue"</span>: <span class="token string">&quot;.add-to-cart&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div class="sc-dUyvyr cEXGsp"></div></div></div>
       <script>
-      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.1.0","info":{"version":"1.89.15","title":"SpaceCat API","description":"The SpaceCat API is used to manage edge delivery site directory and obtain audit information.\n\n## Authentication\n<SecurityDefinitions />\n","termsOfService":"https://www.adobe.com/go/experiencecloudterms","contact":{"name":"Spacecat Team","url":"https://github.com/adobe/spacecat-api-service"},"x-logo":{"url":"https://solaris007.github.io/spacecat-ui/spacecat_logo_192.webp","altText":"SpaceCat logo"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"servers":[{"url":"https://spacecat.experiencecloud.live/api/ci","description":"Development server"},{"url":"https://spacecat.experiencecloud.live/api/v1","description":"Production server"}],"tags":[{"name":"site","description":"Site operations"},{"name":"audit","description":"Audit operations"},{"name":"auth","description":"Init authentication against 3rd party services"},{"name":"organization","description":"Organization operations"},{"name":"trigger","description":"Trigger operations"},{"name":"hooks","description":"Webhooks for receiving events"},{"name":"slack","description":"Slack channel management"},{"name":"api-keys","description":"API key management"},{"name":"import","description":"APIs for importing content to Edge Delivery Services"},{"name":"scrape","description":"APIs for scraping web pages"}],"paths":{"/audits/latest/{auditType}":{"parameters":[{"$ref":"#/components/parameters/auditType"},{"$ref":"#/components/parameters/ascending"}],"get":{"tags":["audit"],"summary":"Retrieve all latest audits of a given type","description":"This endpoint is useful for retrieving all audits of a given type.\nOptionally, the results can be sorted in ascending order by audited at date.\n","operationId":"getAllAudits","responses":{"200":{"description":"A list of audits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditList"}}}},"400":{"$ref":"#/components/responses/400-no-audit-type"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/auth/google/{siteId}":{"parameters":[{"$ref":"#/components/parameters/siteId"}],"get":{"tags":["auth"],"summary":"Authenticate with Google","description":"This endpoint is used to authenticate with Google.\nThe user will be redirected to the Google authentication flow.\n","operationId":"googleAuth","responses":{"200":{"description":"Successful operation and token has been saved"},"302":{"description":"Redirect to Google authentication flow"},"400":{"description":"Missing or invalid parameters"},"404":{"description":"Site matching site found in Google Search Console"},"500":{"$ref":"#/components/responses/500"}},"security":[]}},"/configurations":{"get":{"tags":["configuration"],"summary":"Get all application configurations","operationId":"getAllConfigurations","security":[{"admin_key":[]}],"responses":{"200":{"description":"A list of all known configurations or empty list if no configurations are present.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Configuration"}}}}},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}}}},"/configurations/latest":{"get":{"tags":["configuration"],"summary":"Get the latest application configuration","operationId":"getLatestConfiguration","security":[{"admin_key":[]}],"responses":{"200":{"description":"The latest application configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Configuration"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"description":"Latest configuration not found."},"500":{"$ref":"#/components/responses/500"}}}},"/configurations/{version}":{"get":{"tags":["configuration"],"summary":"Get a specific version of the application configuration","operationId":"getConfigurationByVersion","security":[{"admin_key":[]}],"parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Specific version of the application configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Configuration"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-configuration-not-found-with-version"},"500":{"$ref":"#/components/responses/500"}}}},"/configurations/sites/audits":{"patch":{"tags":["configuration"],"summary":"Enable or disable audits for sites","description":"Use this endpoint to enable or disable specific audit types for your sites.\n","operationId":"update","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"baseURL":{"$ref":"#/components/schemas/URL"},"auditType":{"type":"string","description":"The type of audit to be enabled or disabled.","examples":["cwv",404,"broken-backlinks"]},"enable":{"type":"boolean","description":"Set to true to enable the audit, or false to disable it."}},"required":["baseURL","auditType","enable"]}}}}},"responses":{"207":{"description":"A list of baseURL, the status of the update, and the corresponding site if successful, or the error message if failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigurationSitesAuditsUpdateResult"}}}},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"admin_key":[]}]}},"/event/fulfillment":{"post":{"tags":["hooks"],"summary":"Process fulfillment_completed events","description":"This endpoint can be used to process an array of fulfillment_completed\nevents, in the format produced by the Fulfillment Gateway and \ndelivered by the Hoolihan pipeline. In particular, it is intended to \nbe used to handle contract fulfillment events which involve an Edge \nDelivery Services fulfillable item \"code\".\n","operationId":"processFulfillmentEvents","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HoolihanEvents"}}}},"responses":{"202":{"description":"Accepted for processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FulfillmentProcessingResults"}}}},"400":{"$ref":"#/components/responses/400-bad-hoolihan-event"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"admin_key":[]}]}},"/hooks/site-detection/cdn/{hookSecret}":{"parameters":[{"$ref":"#/components/parameters/hookSecret"}],"post":{"tags":["hooks"],"summary":"Process incoming site discovery hooks from CDN logs","description":"This endpoint processes hooks that include x-forwarded-host header value from CDN logs \nUpon receiving the incoming webhook, it initiates a sequence of validation and sanitization procedures\nOnce successful sanitization and validation are completed, \nit proceeds to send a Slack message notifying about the discovered domain\n","operationId":"siteDetectionCdn","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CDNXForwardedHostAlert"}}}},"responses":{"202":{"description":"hook is accepted"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/hooks/site-detection/rum/{hookSecret}":{"parameters":[{"$ref":"#/components/parameters/hookSecret"}],"post":{"tags":["hooks"],"summary":"Process incoming site discovery hooks from RUM logs","description":"This endpoint processes hooks that include URL and domain information from RUM logs \nUpon receiving the incoming webhook, it initiates a sequence of validation and sanitization procedures\nOnce successful sanitization and validation are completed, \nit proceeds to send a Slack message notifying about the discovered domain\n","operationId":"siteDetectionRum","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RUMDomainDiscoveryAlert"}}}},"responses":{"202":{"description":"hook is accepted"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/hooks/site-integration/analytics/{hookSecret}":{"parameters":[{"$ref":"#/components/parameters/hookSecret"}],"post":{"tags":["hooks"],"summary":"Process setup completed events for site integration with analytics","description":"Not implemented yet (will be via https://github.com/adobe/spacecat-api-service/issues/237).\nProcess setup completed events for site integration with analytics.\n","operationId":"processAnalyticsSiteIntegration","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsSiteIntegration"},"examples":{"analytics-site-integration-aa-tags":{"$ref":"#/components/examples/analytics-site-integration-aa-tags"},"analytics-site-integration-aa-aep-websdk":{"$ref":"#/components/examples/analytics-site-integration-aa-aep-websdk"},"analytics-site-integration-cja-tags":{"$ref":"#/components/examples/analytics-site-integration-cja-tags"},"analytics-site-integration-cja-websdk":{"$ref":"#/components/examples/analytics-site-integration-cja-websdk"}}}}},"responses":{"202":{"description":"Accepted for processing"},"400":{"$ref":"#/components/responses/400-no-site-id"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/organizations":{"post":{"tags":["organization"],"summary":"Create a new organization","description":"This endpoint is useful for creating a new organization.\n","operationId":"createOrganization","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationCreate"}}}},"responses":{"201":{"description":"Organization created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"400":{"$ref":"#/components/responses/400-empty-request-body-validation-failure"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"admin_key":[]}]},"get":{"tags":["organization"],"summary":"Retrieve all organizations","description":"This endpoint is useful for retrieving all organizations.\n","operationId":"getOrganizations","responses":{"200":{"description":"A list of organizations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationList"}}}},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/organizations/{organizationId}":{"parameters":[{"$ref":"#/components/parameters/organizationId"}],"get":{"tags":["organization"],"summary":"Retrieve a single organization by its ID","description":"This endpoint is useful for retrieving an organization by its ID.\n","operationId":"getOrganization","responses":{"200":{"description":"Successful operation with an organization object returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"400":{"$ref":"#/components/responses/400-no-organization-id"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-organization-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]},"patch":{"tags":["organization"],"summary":"Update an organization","description":"This endpoint is useful for updating an organization.\nOnly the fields as per the request body schema will be updated.\nAt least one field to update must be provided in the request body.\n","operationId":"patchOrganization","security":[{"admin_key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationUpdate"}}}},"responses":{"200":{"description":"Organization updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"400":{"$ref":"#/components/responses/400-no-organization-id-request-body-no-updates"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-organization-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"tags":["organization"],"summary":"Delete an organization","description":"This endpoint is useful for deleting an organization.\n","operationId":"deleteOrganization","security":[{"admin_key":[]}],"responses":{"204":{"description":"Organization deleted successfully"},"400":{"$ref":"#/components/responses/400-no-organization-id"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-organization-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}}}},"/organizations/{organizationId}/sites":{"parameters":[{"$ref":"#/components/parameters/organizationId"}],"get":{"tags":["organization","site"],"summary":"Retrieve all sites for an organization","description":"This endpoint is useful for retrieving all sites for an organization.\n","operationId":"getSitesForOrganization","responses":{"200":{"description":"A list of sites","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteList"}}}},"400":{"$ref":"#/components/responses/400-no-organization-id"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-organization-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/organizations/by-ims-org-id/{imsOrgId}":{"parameters":[{"$ref":"#/components/parameters/imsOrgId"}],"get":{"tags":["organization"],"summary":"Retrieve an organization by IMS Org ID","description":"This endpoint is useful for retrieving an organization by IMS Org ID.\n","operationId":"getOrganizationByImsOrgId","responses":{"200":{"description":"Successful operation with an organization object returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"400":{"$ref":"#/components/responses/400-bad-ims-org-id"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/organizations/by-ims-org-id/{imsOrgId}/slack-config":{"parameters":[{"$ref":"#/components/parameters/imsOrgId"}],"get":{"tags":["organization"],"summary":"Retrieve Slack config for an organization by IMS Org ID","description":"This endpoint is useful for retrieving the Slack config of an \norganization by IMS Org ID.\n","operationId":"getSlackConfigByImsOrgId","responses":{"200":{"description":"Successful operation with a Slack config object returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlackConfig"}}}},"204":{"description":"No Slack config found for this IMS Org ID"},"400":{"$ref":"#/components/responses/400-bad-ims-org-id"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/scrape":{"post":{"tags":["scrape"],"summary":"Scrape a set of URLs","description":"Warning: prototype endpoint. \nThis endpoint allows you to scrape a set of URLs. The URLs are scraped in parallel and the results are returned in the same order as the input.\nThe maximum number of URLs that can be scraped in a single request is 10.\n","operationId":"scrape","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScrapeRequest"}}}},"responses":{"200":{"description":"A list of scrape results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScrapeResponse"}}}},"400":{"$ref":"#/components/responses/400-max-scrape-urls-exceeded"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites":{"post":{"tags":["site"],"summary":"Create a new site","description":"This endpoint is useful for creating a new site.\n","operationId":"createSite","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteCreate"}}}},"responses":{"201":{"description":"Site created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Site"}}}},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"admin_key":[]}]},"get":{"tags":["site"],"summary":"Retrieve all sites","description":"This endpoint is useful for retrieving all sites.\n","operationId":"getSites","responses":{"200":{"description":"A list of sites","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteList"}}}},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/by-delivery-type/{deliveryType}":{"parameters":[{"$ref":"#/components/parameters/deliveryType"}],"get":{"tags":["site"],"summary":"Retrieve all sites by delivery type","description":"This endpoint is useful for retrieving all sites by delivery type.\n","operationId":"getSitesByDeliveryType","responses":{"200":{"description":"A list of sites","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteList"}}}},"400":{"$ref":"#/components/responses/400-no-delivery-type"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/by-base-url/{base64BaseUrl}":{"parameters":[{"$ref":"#/components/parameters/base64BaseUrl"}],"get":{"tags":["site"],"summary":"Retrieve a single site by its Base URL","description":"This endpoint is useful for retrieving a site when you only have its Base URL. The Base URL is a unique identifier for a site other than the Site ID.\nThe base URL provided in the path must be base64 encoded. This is to allow for URLs with special characters to be used as path parameters.\n","operationId":"getSiteByBaseUrl","responses":{"200":{"description":"Successful operation with a site object returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Site"}}}},"400":{"$ref":"#/components/responses/400-no-base-url"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-base-url"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/with-latest-audit/{auditType}":{"parameters":[{"$ref":"#/components/parameters/auditType"}],"get":{"tags":["site"],"summary":"Retrieve all sites including their latest audit","description":"This endpoint is useful for retrieving all sites including their latest audit.\nThe latest audit is determined by the auditedAt property of the audit and\nincluded in the audits array of the site object.\n","operationId":"getSitesWithLatestAudit","responses":{"200":{"description":"A list of sites with their latest audit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteWithLatestAuditList"}}}},"400":{"$ref":"#/components/responses/400-no-audit-type"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/latest-metrics":{"get":{"summary":"Get latest site metrics","description":"Retrieves the latest metrics for a specific site, including RUM (Real User Monitoring)\ndata and organic traffic metrics. Returns zeroed values if no data is available or\nno RUM domain key is configured.\n","parameters":[{"$ref":"#/components/parameters/siteId"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"pageViewsChange":{"type":"number","description":"Percentage change in page views compared to the previous period"},"ctrChange":{"type":"number","description":"Percentage change in Click-Through Rate (CTR) compared to the previous period"},"projectedTrafficValue":{"type":"number","description":"Projected traffic value based on page views change and cost per click"}}}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}],"tags":["metrics","site"]}},"/sites/{siteId}":{"parameters":[{"$ref":"#/components/parameters/siteId"}],"get":{"tags":["site"],"summary":"Retrieve a single site by its ID","description":"This endpoint is useful for retrieving a site by its ID.\n","operationId":"getSite","responses":{"200":{"description":"Successful operation with a site object returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Site"}}}},"400":{"$ref":"#/components/responses/400-no-site-id"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]},"patch":{"tags":["site"],"summary":"Update a site","description":"This endpoint is useful for updating a site.\nOnly the fields as per the request body schema will be updated.\nAt least one field to update must be provided in the request body.\n","operationId":"patchSite","security":[{"admin_key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteUpdate"}}}},"responses":{"200":{"description":"Site updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Site"}}}},"400":{"$ref":"#/components/responses/400-no-site-id-request-body-no-updates"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"tags":["site"],"summary":"Delete a site","description":"This endpoint is useful for deleting a site.\n","operationId":"deleteSite","security":[{"admin_key":[]}],"responses":{"204":{"description":"Site deleted successfully"},"400":{"$ref":"#/components/responses/400-no-site-id"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}}}},"/sites/{siteId}/audits":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/ascending"}],"get":{"tags":["audit"],"summary":"Retrieve all audits for a site","description":"This endpoint is useful for retrieving all audits for a site.\nOptionally, the results can be sorted in ascending order by audited at date.\n","operationId":"getAllAuditsForSite","responses":{"200":{"description":"A list of audits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditList"}}}},"400":{"$ref":"#/components/responses/400-no-site-id"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/audits/{auditType}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/auditType"},{"$ref":"#/components/parameters/ascending"}],"get":{"tags":["audit"],"summary":"Retrieve all audits of a given type for a site","description":"This endpoint is useful for retrieving all audits of a given type for a site.\nOptionally, the results can be sorted in ascending order by audited at date.\n","operationId":"getAllAuditsOfTypeForSite","responses":{"200":{"description":"A list of audits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditList"}}}},"400":{"$ref":"#/components/responses/400-no-site-id"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/audits/{auditType}/{auditedAt}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/auditType"},{"$ref":"#/components/parameters/auditedAt"}],"get":{"tags":["audit"],"summary":"Retrieve a single audit for a site","description":"This endpoint is useful for retrieving a single audit for a site.\nThe audit is identified by the auditedAt property of the audit and\nthe audit type.\n","operationId":"getAuditForSite","responses":{"200":{"description":"An audit object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audit"},"examples":{"generic-audit":{"$ref":"#/components/examples/generic-audit"},"broken-backlinks-audit":{"$ref":"#/components/examples/broken-backlinks-audit"},"costs-audit":{"$ref":"#/components/examples/costs-audit"},"meta-tags-audit":{"$ref":"#/components/examples/meta-tags-audit"},"broken-internal-links-audit":{"$ref":"#/components/examples/broken-internal-links-audit"}}}}},"400":{"$ref":"#/components/responses/400-audit-for-site"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-audit-not-found"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/audits/latest":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/ascending"}],"get":{"tags":["audit"],"summary":"Retrieve all audits for a site","description":"This endpoint is useful for retrieving all audits for a site.\nOptionally, the results can be sorted in ascending order by audited at date.\n","operationId":"getAllAuditsForSite","responses":{"200":{"description":"A list of audits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditList"}}}},"400":{"$ref":"#/components/responses/400-no-site-id"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/latest-audit/{auditType}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/auditType"}],"get":{"tags":["audit"],"summary":"Retrieve the latest audit for a site","description":"This endpoint is useful for retrieving the latest audit for a site.\nThe latest audit is determined by the given audit type and will be \nincluded in the audits array of the site object.\n","operationId":"getLatestAuditForSite","responses":{"200":{"description":"An audit object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audit"},"examples":{"generic-audit":{"$ref":"#/components/examples/generic-audit"},"broken-backlinks-audit":{"$ref":"#/components/examples/broken-backlinks-audit"},"costs-audit":{"$ref":"#/components/examples/costs-audit"},"meta-tags-audit":{"$ref":"#/components/examples/meta-tags-audit"},"broken-internal-links-audit":{"$ref":"#/components/examples/broken-internal-links-audit"}}}}},"400":{"$ref":"#/components/responses/400-latest-audit-for-site"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-audit-not-found"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/{auditType}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/auditType"}],"patch":{"tags":["audit","site"],"summary":"Update the configuration for an audit","description":"This endpoint is useful for updating the configuration for an audit, \nfor example to set which URLs to skip from the audit.\n","operationId":"patchAuditForSite","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateHandlerTypeConfig"}}}},"responses":{"200":{"description":"The updated audit type config object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandlerConfig"}}}},"400":{"$ref":"#/components/responses/400-patch-audit-for-site"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-audit-not-found"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/opportunities":{"parameters":[{"$ref":"#/components/parameters/siteId"}],"get":{"summary":"Retrieve a list of all opportunities for a specific site\n","tags":["opportunities"],"responses":{"200":{"description":"A list of opportunities","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpportunityList"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"ims_key":[]}]},"post":{"summary":"Create a new opportunity for a specific site\n","tags":["opportunities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpportunityCreate"},"examples":{"broken-backlinks-opportunity":{"$ref":"#/components/examples/broken-backlinks-opportunity-create"}}}}},"responses":{"201":{"description":"Opportunity created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Opportunity"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"ims_key":[]}]}},"/sites/{siteId}/opportunities/by-status/{status}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"name":"status","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"Retrieve opportunities for a specific site filtered by status\n","tags":["opportunities"],"responses":{"200":{"description":"A list of opportunities filtered by status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpportunityList"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"ims_key":[]}]}},"/sites/{siteId}/opportunities/{opportunityId}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/opportunityId"}],"get":{"summary":"Retrieve details of a specific opportunity\n","tags":["opportunities"],"responses":{"200":{"description":"Details of the opportunity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Opportunity"},"examples":{"broken-backlinks-opportunity":{"$ref":"#/components/examples/broken-backlinks-opportunity"}}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"ims_key":[]}]},"patch":{"summary":"Update specific attributes of an existing opportunity\n","tags":["opportunities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpportunityUpdate"},"examples":{"broken-backlinks-opportunity-update":{"$ref":"#/components/examples/broken-backlinks-opportunity-update"}}}}},"responses":{"200":{"description":"Opportunity updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Opportunity"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"ims_key":[]}]},"delete":{"summary":"Delete an opportunity and associated suggestions + fixes\n","tags":["opportunities"],"responses":{"204":{"description":"Opportunity deleted"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"ims_key":[]}]}},"/sites/{siteId}/opportunities/{opportunityId}/suggestions":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/opportunityId"}],"get":{"summary":"Retrieve a list of all suggestions for a specific opportunity\n","tags":["opportunity-suggestions"],"responses":{"200":{"description":"A list of suggestions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestionList"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"ims_key":[]}]},"post":{"summary":"Create and add a list of one or more suggestions to an opportunity in one transaction\n","tags":["opportunity-suggestions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestionCreateList"},"examples":{"broken-backlinks-suggestion-create-list":{"$ref":"#/components/examples/broken-backlinks-suggestion-create-list"}}}}},"responses":{"207":{"description":"A list of suggestions created and added to the opportunity, \nor the status code and error message for the ones failed.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestionCreateListResponse"},"examples":{"broken-backlinks-suggestion-create-list-response":{"$ref":"#/components/examples/broken-backlinks-suggestion-create-list-response"}}}}}},"security":[{"ims_key":[]}]}},"/sites/{siteId}/opportunities/{opportunityId}/suggestions/by-status/{status}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/opportunityId"},{"name":"status","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"Retrieve suggestions for a specific opportunity filtered by status\n","tags":["opportunity-suggestions"],"responses":{"200":{"description":"A list of suggestions filtered by status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestionList"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"ims_key":[]}]}},"/sites/{siteId}/opportunities/{opportunityId}/suggestions/{suggestionId}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/opportunityId"},{"$ref":"#/components/parameters/suggestionId"}],"get":{"summary":"Retrieve details of a specific suggestion\n","tags":["opportunity-suggestions"],"responses":{"200":{"description":"Details of the suggestion","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Suggestion"},"examples":{"broken-backlinks-suggestion":{"$ref":"#/components/examples/broken-backlinks-suggestion"}}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"ims_key":[]}]},"patch":{"summary":"Update specific attributes of an existing suggestion\n","tags":["opportunity-suggestions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestionUpdate"},"examples":{"broken-backlinks-suggestion-update":{"$ref":"#/components/examples/broken-backlinks-suggestion-update"}}}}},"responses":{"200":{"description":"Suggestion updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Suggestion"},"examples":{"broken-backlinks-suggestion":{"$ref":"#/components/examples/broken-backlinks-suggestion"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"ims_key":[]}]},"delete":{"summary":"Delete a suggestion\n","tags":["opportunity-suggestions"],"responses":{"204":{"description":"Suggestion deleted"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"ims_key":[]}]}},"/sites/{siteId}/opportunities/{opportunityId}/suggestions/status":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/opportunityId"}],"patch":{"summary":"Update the status of one or multiple suggestions in one transaction\n","tags":["opportunity-suggestions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestionStatusUpdate"},"examples":{"broken-backlinks-suggestions-status-update":{"$ref":"#/components/examples/broken-backlinks-suggestions-status-update"}}}}},"responses":{"207":{"description":"A list of suggestions updated, \nor the status code and error message for the ones failed.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestionStatusUpdateListResponse"},"examples":{"broken-backlinks-suggestions-status-update-response":{"$ref":"#/components/examples/broken-backlinks-suggestions-status-update-response"}}}}}},"security":[{"ims_key":[]}]}},"/sites/{siteId}/key-events":{"parameters":[{"$ref":"#/components/parameters/siteId"}],"get":{"tags":["site","key event"],"summary":"Retrieve key events for a site","description":"This endpoint returns key events for a site chronologically, starting from the most recent and descending to the least recent\n","operationId":"getKeyEvents","responses":{"200":{"description":"A list of key events for the requested sites","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyEventsList"}}}},"400":{"$ref":"#/components/responses/400-no-site-id"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]},"post":{"tags":["site","key event"],"summary":"Create a new key event for a site","description":"The endpoint for creating new key events for a site\n","operationId":"createKeyEvent","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyEventCreate"}}}},"responses":{"201":{"description":"Key event created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyEvent"}}}},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/key-events/{keyEventId}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/keyEventId"}],"delete":{"tags":["site","key event"],"summary":"Delete a key event","description":"The endpoint for deleting a key event\n","operationId":"deleteKeyEvent","security":[{"api_key":[]}],"responses":{"204":{"description":"Key event deleted successfully"},"400":{"$ref":"#/components/responses/400-no-key-event-id"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-key-event-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}}}},"/sites/{siteId}/top-pages":{"parameters":[{"$ref":"#/components/parameters/siteId"}],"get":{"tags":["site","top pages"],"summary":"Retrieve top pages for site","description":"Not implemented yet.\nThis endpoint is useful for retrieving top pages for a site.\nThe top pages will be ordered in buckets by source and geo,\nand in descending order by traffic within these buckets.\n","operationId":"getSiteTopPages","responses":{"200":{"description":"A list of site top pages","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteTopPageList"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/top-pages/{source}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/source"}],"get":{"tags":["site","top pages"],"summary":"Retrieve top pages for site by source","description":"Not implemented yet.\nThis endpoint is useful for retrieving top pages for a site.\nThe top pages will be ordered in buckets by geo,\nand in descending order by traffic within these buckets.\n","operationId":"getSiteTopPagesBySource","responses":{"200":{"description":"A list of site top pages","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteTopPageList"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/top-pages/{source}/{geo}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/source"},{"$ref":"#/components/parameters/geo"}],"get":{"tags":["site","top pages"],"summary":"Retrieve top pages for site by source and geo","description":"Not implemented yet.\nThis endpoint is useful for retrieving top pages for a site.\nThe top pages will be ordered in descending order by traffic.\n","operationId":"getSiteTopPagesBySourceAndGeo","responses":{"200":{"description":"A list of site top pages","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteTopPageList"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/metrics/{metric}/{source}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/source"},{"$ref":"#/components/parameters/metric"}],"get":{"tags":["metrics","site"],"summary":"Retrieve site metrics by source","description":"This endpoint is useful for retrieving site metrics by source.\n","operationId":"getSiteMetricsBySource","responses":{"200":{"description":"A list of site metrics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteMetricList"}}}},"400":{"$ref":"#/components/responses/400-no-site-id"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/metrics/{metric}/{source}/by-url/{base64PageUrl}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/source"},{"$ref":"#/components/parameters/metric"},{"$ref":"#/components/parameters/base64PageUrl"}],"get":{"tags":["metrics","site"],"summary":"Retrieve page metrics by source","description":"This endpoint is useful for retrieving page metrics by source\n","operationId":"getPageMetricsBySource","responses":{"200":{"description":"A list of page metrics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageMetricList"}}}},"400":{"$ref":"#/components/responses/400-no-site-id"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/experiments":{"parameters":[{"$ref":"#/components/parameters/siteId"}],"get":{"tags":["site","experiments"],"summary":"Retrieves all experiments for the site","description":"This endpoint provide a list of experiments obtained from RUM data for the given site along with all the experiment details.\n","operationId":"getExperiments","responses":{"200":{"description":"A list of site experiments","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteExperimentList"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/slack/channels/invite-by-user-id":{"post":{"tags":["slack"],"summary":"Request invitation to an existing Slack channel of an organization","description":"This endpoint can be used to invite a user to their organization's Slack \nchannel by IMS user ID, which is read from the IMS API via the provided \nuser access token. As a prerequisite, there must be an existing Spacecat \norganization and Slack channel for the given IMS org ID.\n","operationId":"inviteToSlackChannelByUserId","security":[{"admin_key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlackInviteToChannelByUserIdRequest"}}}},"responses":{"202":{"description":"Request accepted, invite(s) to follow by email if successful"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-organization-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}}}},"/trigger":{"parameters":[{"$ref":"#/components/parameters/triggerUrl"},{"$ref":"#/components/parameters/triggerType"}],"get":{"tags":["trigger"],"summary":"Trigger an audit","deprecated":true,"description":"**Warning:** This API is deprecated, will be removed in future versions and should no longer be used or enhanced.\nPlease use the Slack commands to trigger audits on-demand.\n\nThis endpoint is useful for triggering an audit.\nThe audit will be run asynchronously and the response will be returned immediately.\n\nThe audit type is determined by the type parameter and must be one of the following:\n  - 404\n  - apex\n  - cwv\n  - lhs\n  - lhs-desktop\n  - lhs-mobile\n\nThe URL can be either a site ID or a base URL depending on the audit type.\n","operationId":"triggerAudit","responses":{"200":{"description":"Audit triggered successfully"},"400":{"$ref":"#/components/responses/400-missing-params-or-unknown-audit-type"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"admin_key":[]}]}},"/tools/api-keys":{"post":{"tags":["api-keys"],"summary":"Create a new API key","description":"This endpoint can be used to create a new API key with a set of scopes. The scoped API key will be\nreturned in the response only once. The scoped API key can be used to authenticate the Spacecat APIs by\nincluding it in the x-api-key header.\n","operationId":"createApiKey","security":[{"ims_key":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyRequest"}}}},"parameters":[{"in":"header","name":"x-gw-ims-org-id","schema":{"type":"string"},"description":"IMS Organization Id of the client.\n","example":"1234567890ABCDEF12345678@AdobeOrg"}],"responses":{"201":{"description":"API key created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyResponse"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403-max-api-keys-exceeded"},"500":{"$ref":"#/components/responses/500"}}},"get":{"tags":["api-keys"],"summary":"Get all API keys owned by the given IMS client","description":"This endpoint can be used to list all the API keys created by the client.\n","operationId":"getApiKeys","security":[{"ims_key":[]}],"parameters":[{"in":"header","name":"x-gw-ims-org-id","schema":{"type":"string"},"description":"IMS Organization Id of the client.\n","example":"1234567890ABCDEF12345678@AdobeOrg"}],"responses":{"200":{"description":"API key metadata returned successfully. Note that the API key itself will not be included in this list, as it's only displayed once (at creation).\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiKeyMetadataResponse"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}}}},"/tools/api-keys/{apiKeyId}":{"delete":{"tags":["api-keys"],"summary":"Delete an API key","description":"This endpoint can be used to delete an API key. The API key will be marked as deleted in the system and\nwill no longer be valid for authentication. Only keys created by this IMS client can be deleted by it.\n","operationId":"deleteApiKey","security":[{"ims_key":[]}],"parameters":[{"$ref":"#/components/parameters/apiKeyId"},{"in":"header","name":"x-gw-ims-org-id","schema":{"type":"string"},"description":"IMS Organization Id of the client.\n","example":"1234567890ABCDEF12345678@AdobeOrg"}],"responses":{"204":{"description":"API key deleted successfully."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/tools/import/jobs":{"post":{"tags":["import"],"summary":"Create a new import job","description":"This endpoint can be used to start a new import job with a set of URLs, import API key,\noptional import.js mapping file, and optional custom headers. The import job will be processed \nasynchronously and the status of the job can be queried at the /tools/import/jobs/{jobId} endpoint.\nIf there is no import queue available at the time of the request, a 503 Service Unavailable response will\nbe returned. A single import job per client is permitted, otherwise a 429 Too Many Requests\nresponse will be returned.\n","operationId":"startImportJob","security":[{"scoped_api_key":[]}],"parameters":[{"in":"header","name":"x-api-key","schema":{"type":"string"},"description":"Client-specific import API key. This same key will be required to fetch the job status, \nand final .zip result.\n"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImportJobRequest"}}}},"responses":{"202":{"description":"Import job accepted for processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportJobStatus"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}}}},"/tools/import/jobs/{jobId}":{"get":{"tags":["import"],"summary":"Query the status of an import job","description":"This endpoint can be used to query the status of an import job, given its jobId.\n","operationId":"getImportJobStatus","security":[{"scoped_api_key":[]}],"parameters":[{"$ref":"#/components/parameters/jobId"},{"in":"header","name":"x-api-key","schema":{"type":"string"},"description":"Client-specific import API key. Must match the key used to start the import job.\n"}],"responses":{"200":{"description":"Successful operation with an import status object returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportJobStatus"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"tags":["import"],"summary":"Delete an import job","description":"This endpoint can be used to delete an import job, given its jobId. This operation will remove\nall import URL entities in addition to the import job itself. The `imports.delete` scope is \nrequired on the API key used to delete the import job, and only jobs created by the provided\nkey can be deleted.\n","operationId":"deleteImportJob","security":[{"scoped_api_key":[]}],"parameters":[{"$ref":"#/components/parameters/jobId"},{"in":"header","name":"x-api-key","schema":{"type":"string"},"description":"Client-specific import API key. Must match the key used to start the import job, and\ninclude the imports.delete scope.\n"}],"responses":{"204":{"description":"Import job deleted successfully."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}},"patch":{"tags":["import"],"summary":"Patch an import job","description":"This endpoint can be used to stop an import job, given its jobId. This operation will prevent\nany further scraping of the import job URLs, and mark the job status as STOPPED. The results\nwill not be saved to storage, allowing the user to start a new import immediately.\n","operationId":"stopImportJob","security":[{"scoped_api_key":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ImportJobStopRequest"}}}}},"parameters":[{"$ref":"#/components/parameters/jobId"},{"in":"header","name":"x-api-key","schema":{"type":"string"},"description":"Client-specific import API key. Must match the key used to start the import job, and\ninclude the imports.write scope.\n"}],"responses":{"204":{"description":"Import job stopped successfully."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/tools/import/jobs/{jobId}/progress":{"get":{"tags":["import"],"summary":"Query the progress of an import job","description":"This endpoint can be used to query the progress of an import job, given its jobId.\n","operationId":"getImportJobProgress","security":[{"scoped_api_key":[]}],"parameters":[{"$ref":"#/components/parameters/jobId"},{"in":"header","name":"x-api-key","schema":{"type":"string"},"description":"Client-specific import API key. Must match the key used to start the import job.\n"}],"responses":{"200":{"description":"The current progress of the import job.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportJobProgress"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/tools/import/jobs/{jobId}/result":{"post":{"tags":["import"],"summary":"Request a pre-signed URL to download the result of an import job as a .zip archive","description":"This endpoint can be used to download an archive of an import job, which will include\nall the resulting documents that were generated as part of the import. It will also \ninclude the import-report.xlsx file, which contains a summary of the import job.\n","operationId":"getImportJobArchive","security":[{"scoped_api_key":[]}],"parameters":[{"$ref":"#/components/parameters/jobId"},{"in":"header","name":"x-api-key","schema":{"type":"string"},"description":"Client-specific import API key. Must match the key used to start the import job.\n"}],"responses":{"200":{"description":"Successful operation with an import archive delivered to the client.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportJobArchive"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/tools/import/assistant/prompt":{"post":{"tags":["import"],"summary":"Send a prompt to the import assistant","description":"Note: Not implemented yet.\n\nThis endpoint can be used to send prompts to the import assistant.\nEach prompt will make use of AI to analyze a URL and return\nchoices in response to the request.\n","operationId":"processImportAssistant","security":[{"scoped_api_key":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportAssistantRequest"}}}},"parameters":[{"in":"header","name":"x-api-key","schema":{"type":"string"},"description":"Client-specific import API key with the 'imports.assistant' scope.\n"}],"responses":{"200":{"description":"Contents of the response from the import AI assistant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportAssistantResponse"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}},"components":{"securitySchemes":{"api_key":{"type":"apiKey","in":"header","name":"x-api-key","description":"DEPRECATED, use scoped_api_key or ims_key. (Used for read-only operations.)"},"scoped_api_key":{"type":"apiKey","in":"header","name":"x-api-key","description":"For endpoints which authenticate with scoped API keys"},"ims_key":{"type":"apiKey","in":"header","name":"authorization","description":"Value must be a valid IMS user token which will be offline-validated."},"admin_key":{"type":"apiKey","in":"header","name":"x-api-key","description":"DEPRECATED, use scoped_api_key or ims_key. (Used for read and write operations.)"}},"schemas":{"AuditType":{"type":"string","enum":["404","apex","cwv","lhs","lhs-desktop","lhs-mobile","broken-backlinks","canonical","sitemap","structured-data","costs","meta-tags","broken-internal-links","experimentation-opportunities"],"example":"cwv"},"Id":{"type":"string","format":"uuid","readOnly":true,"example":"123e4567-e89b-12d3-a456-426614174000"},"DateTime":{"type":"string","format":"date-time","example":"2024-01-19T14:20:30Z"},"DeliveryType":{"type":"string","enum":["aem_edge","aem_cs","other"],"example":"aem_edge"},"ExperimentationOpportunity":{"type":"object","readOnly":true,"properties":{"type":{"type":"string","description":"Type of the experimentation opportunity","example":"generic"},"page":{"type":"string","description":"The title of the webpage","example":"Retirement Calculator"},"screenshot":{"type":"string","format":"url","description":"A URL pointing to the screenshot of the webpage.","example":"https://space.cat/screenshots/some-cool-page.png"},"trackedPageKPIName":{"type":"string","description":"The name of KPI tracked.","example":"Bounce rate"},"trackedPageKPIValue":{"type":"number","description":"The value of KPI tracked for this page.","example":0.8},"trackedKPISiteAverage":{"type":"number","description":"The average value of KPI tracked across the site.","example":0.45},"pageviews":{"type":"integer","description":"The total number of views this webpage has received","example":15000},"samples":{"type":"integer","description":"The total number of samples we have for this webpage in RUM","example":150},"activeExperiments":{"type":"string","description":"The number of active experiments on the webpage, or 'none' if there are no active experiments.","examples":["None","2 active"]},"metrics":{"type":"array","description":"The metrics for the experimentation opportunity","items":{"type":"object"}},"recommendations":{"type":"array","description":"The recommendations for the experimentation opportunity","items":{"type":"object"},"example":[{"type":"guidance","insight":"The main CTAs (\"Buy now\", \"Free trial\") are not prominently visible above the fold for users coming from platforms like TikTok.","recommendation":"Relocate one of the primary CTAs, such as \"Buy now\", to a more prominent position above the fold where it is immediately visible upon landing on the page."},{"type":"guidance","insight":"The current design and layout of the page, while visually appealing, might be overwhelming for users coming from TikTok who prefer short and concise content.","recommendation":"Simplify the page by reducing the amount of text and focusing on key features with visually engaging images or short videos, particularly near the top of the page."}]}}},"URL":{"type":"string","format":"url","example":"https://www.example.com"},"BrokenBacklink":{"type":"object","properties":{"url_to":{"description":"The URL of the broken link.","$ref":"#/components/schemas/URL"},"title":{"description":"The title of the page referring to the broken link.","type":"string"},"url_from":{"description":"The URL of the page referring to the broken link.","$ref":"#/components/schemas/URL"},"traffic_domain":{"description":"The referring domain's estimated monthly organic traffic from search.","type":"number"}}},"Priority":{"type":"string","enum":["high","medium","low"],"example":"high"},"BrokenInternalLink":{"type":"object","properties":{"urlTo":{"description":"The URL of the broken internal link.","$ref":"#/components/schemas/URL"},"title":{"description":"The title of the internal page referring to the broken internal link.","type":"string"},"urlFrom":{"description":"The URL of the internal page referring to the broken link.","$ref":"#/components/schemas/URL"},"trafficDomain":{"description":"The referring page's estimated monthly organic traffic.","type":"number"},"priority":{"description":"The priority of the broken internal link","$ref":"#/components/schemas/Priority"}}},"Verdict":{"type":"string","description":"High-level verdict about whether the URL is indexed.","enum":["VERDICT_UNSPECIFIED","PASS","PARTIAL","FAIL","NEUTRAL"]},"StructuredData":{"type":"object","readOnly":true,"properties":{"inspectionUrl":{"type":"string","description":"The URL that was inspected"},"indexStatusResult":{"type":"object","description":"Result of the index status analysis.","properties":{"verdict":{"$ref":"#/components/schemas/Verdict"},"lastCrawlTime":{"$ref":"#/components/schemas/DateTime"}}},"richResults":{"type":"object","description":"Result of the Rich Results analysis. Absent if there are no rich results found.","properties":{"verdict":{"$ref":"#/components/schemas/Verdict"},"detectedItemTypes":{"type":"array","description":"A list of zero or more rich result types detected on this page.","items":{"type":"string","example":"Product snippets"}},"detectedIssues":{"type":"array","description":"A list of zero or more rich results errors detected on this page.","items":{"type":"object","properties":{"richResultType":{"type":"string","description":"Rich Results type detected on this page.","example":"Product snippets"},"items":{"type":"array","description":"List of Rich Results items that have issues.","items":{"type":"object","properties":{"name":{"type":"string","description":"The user-provided name of this item.","example":"Product name"},"issues":{"type":"array","description":"A list of rich result issues found for this instance.","items":{"type":"object","properties":{"issueMessage":{"type":"string","description":"Rich Results issue type.","example":"Missing field \"image\""},"severity":{"type":"string","description":"Severity of this issue.","example":"ERROR"}}}}}}}}}}}}}},"CWVMetric":{"type":"object","properties":{"deviceType":{"type":"string","description":"The type of device","enum":["mobile","desktop"],"example":"mobile"},"pageviews":{"type":"integer","description":"Total pageviews for this device type","example":2120},"lcp":{"type":"number","format":"float","description":"Largest Contentful Paint (LCP) metric","example":2099.7},"lcpCount":{"type":"integer","description":"The count of LCP samples","example":9},"cls":{"type":"number","format":"float","description":"Cumulative Layout Shift (CLS) metric","example":0.02066},"clsCount":{"type":"integer","description":"The count of CLS samples","example":7},"inp":{"type":"integer","format":"float","description":"Interaction to Next Paint (INP) metric","example":12},"inpCount":{"type":"integer","description":"The count of INP samples","example":3},"ttfb":{"type":"number","format":"float","description":"Time to First Byte (TTFB) metric","example":520.45},"ttfbCount":{"type":"integer","description":"The count of TTFB samples","example":18}}},"AuditResult":{"description":"The result of an audit, which is dependent on the audit type.","oneOf":[{"type":"object","additionalProperties":true},{"type":"object","properties":{"experimentationOpportunities":{"type":"array","description":"A list of experimentation opportunities","items":{"$ref":"#/components/schemas/ExperimentationOpportunity"}}}},{"type":"object","description":"The result of broken-backlinks audit.\n","properties":{"brokenBacklinks":{"type":"array","description":"A list of broken backlinks.","items":{"$ref":"#/components/schemas/BrokenBacklink"}},"fullAuditRef":{"description":"A reference by which the full external result of an audit can be accessed, which is dependent on the audit type.\n","type":"string"}}},{"type":"object","description":"The result of broken-internal-links audit.\n","properties":{"brokenInternalLinks":{"type":"array","description":"A list of broken internal links.","items":{"$ref":"#/components/schemas/BrokenInternalLink"}},"fullAuditRef":{"description":"A reference by which the full external result of an audit can be accessed, which is dependent on the audit type.\n","type":"string"},"finalUrl":{"description":"The final URL for the audited page.","type":"string"}}},{"type":"array","description":"Information about the provided URLs in the Google index.","items":{"$ref":"#/components/schemas/StructuredData"}},{"type":"object","description":"The result of costs audit.\n","properties":{"ahrefs":{"type":"object","properties":{"usedApiUnits":{"description":"API units used so far in the current month.\n","type":"integer"},"limitApiUnits":{"description":"Limit of API units for the current month.\n","type":"integer"},"fullAuditRef":{"description":"A reference by which the full external result of an audit can be accessed, which is dependent on the audit type.\n","type":"string"}}}}},{"type":"object","description":"The result of a meta-tags audit.\n","properties":{"auditResult":{"type":"object","properties":{"detectedTags":{"description":"A mapping of URLs to their detected meta-tags issues and recommendations.\n","type":"object","additionalProperties":{"type":"object","properties":{"title":{"type":"object","properties":{"seoRecommendation":{"description":"SEO recommendation for the title tag.\n","type":"string"},"issue":{"description":"The issue detected in the title tag.\n","type":"string"},"issueDetails":{"description":"Detailed explanation of the issue detected in the title tag.\n","type":"string"},"seoImpact":{"description":"The impact of the detected issue on SEO.\n","type":"string"}}}}}},"finalUrl":{"description":"The final URL for the audited page.\n","type":"string"}}}}},{"type":"object","description":"The result of CWV audit","properties":{"cwv":{"type":"array","description":"A list of CWV metrics per device type","items":{"type":"object","properties":{"type":{"type":"string","enum":["group","url"],"description":"Specifies if the metric applies to a 'group' or an individual 'url'"},"name":{"type":"string","description":"Name of the group (only applicable when type is 'group')","example":"Homepage Group"},"pattern":{"type":"string","description":"URL pattern for the group (only applicable when type is 'group')","example":"https://www.aem.live/home*"},"url":{"description":"URL of the page (only applicable when type is 'url')","$ref":"#/components/schemas/URL"},"pageviews":{"type":"integer","description":"Total pageviews for this group or URL","example":4620},"organic":{"type":"integer","description":"Total organic traffic for this group or URL","example":2510},"metrics":{"type":"array","description":"Array of performance metrics by device type","items":{"$ref":"#/components/schemas/CWVMetric"}}}}}}}]},"Audit":{"type":"object","readOnly":true,"properties":{"siteId":{"description":"The ID of the site this audit belongs to","$ref":"#/components/schemas/Id"},"auditedAt":{"description":"The date and time of the audit in ISO 8601 format","$ref":"#/components/schemas/DateTime"},"expiresAt":{"description":"The date and time when the audit expires in ISO 8601 format","$ref":"#/components/schemas/DateTime"},"deliveryType":{"description":"The type of the delivery this site is using","$ref":"#/components/schemas/DeliveryType"},"fullAuditRef":{"description":"A reference by which the full external result of an audit can be accessed, which is dependent on the audit type.\n","type":"string"},"auditResult":{"$ref":"#/components/schemas/AuditResult"},"previousAuditResult":{"$ref":"#/components/schemas/AuditResult"}},"example":{"siteId":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","auditedAt":"2024-01-20T12:00:00Z","expiresAt":"2024-07-20T12:00:00Z","auditType":"cwv","isError":false,"deliveryType":"aem_edge","fullAuditRef":"https://some-audit-system/full-report/1234","auditResult":{"someProperty":"someValue"},"previousAuditResult":{"someProperty":"somePreviousValue"}}},"AuditList":{"type":"array","items":{"$ref":"#/components/schemas/Audit"}},"Job":{"type":"object","properties":{"group":{"type":"string","description":"The group or category to which the job belongs, helping in organizing jobs by their functional area."},"interval":{"type":"string","description":"Specifies how often the job should run, e.g., 'daily'. This is part of job scheduling information."},"type":{"type":"string","description":"The job type, indicating the specific action or task that the job performs, such as 'rum-to-aa' indicating a data import job from RUM to AA."}}},"Configuration":{"type":"object","properties":{"version":{"type":"string","readOnly":true,"description":"Internal version of the configuration, managed and incremented by the system. Not exposed for external control via the API."},"jobs":{"type":"array","items":{"$ref":"#/components/schemas/Job"},"description":"A list of job configurations, detailing job type, its group, and execution interval."},"queues":{"type":"object","properties":{"audits":{"type":"string","format":"url","description":"The SQS queue name for audit jobs"},"imports":{"type":"string","format":"url","description":"The SQS queue name for import jobs"},"reports":{"type":"string","format":"url","description":"The SQS queue name for report jobs"}}}}},"ConfigurationSitesAuditsUpdateResult":{"type":"object","properties":{"status":{"type":"integer","description":"The HTTP status code of the operation (e.g., 200 for success)"},"message":{"type":"string","description":"A message indicating the result of the operation"}},"required":["status","message"]},"HoolihanHeaders":{"type":"object","properties":{"x-request-id":{"description":"The request ID","type":"array","items":{"$ref":"#/components/schemas/Id"}},"miso-trace-id":{"description":"The Miso trace ID","type":"array","items":{"type":"string"}},"com-adobe-hoolihan-source-partition":{"description":"The source partition","type":"array","items":{"type":"string"}},"com-adobe-hoolihan-source-offset":{"description":"The source offset","type":"array","items":{"type":"string"}},"com-adobe-hoolihan-publish-time":{"description":"The time the event was published in milliseconds since the Unix Epoch","type":"array","items":{"type":"string","example":"1705914000000"}},"x-api-key":{"description":"The API key of the client which published the original event","type":"array","items":{"type":"string"}},"com-adobe-hoolihan-publisher":{"description":"The publisher of the original event","type":"array","items":{"type":"string"}},"com-adobe-hoolihan-source-topic":{"description":"The topic that the original event was published to","type":"array","items":{"type":"string"}},"com-adobe-hoolihan-on-behalf-of":{"description":"The client ID(s) that the event was forwarded on behalf of","type":"array","items":{"type":"string"}},"Content-Type":{"description":"The content type of the event value","type":"array","items":{"type":"string","example":"application/json"}}}},"HoolihanEventValue":{"type":"object","required":["content","headers"],"properties":{"content":{"description":"The JSON payload of the event, encoded as a Base64 string","type":"string"},"headers":{"description":"Metadata headers included by Hoolihan on each event","$ref":"#/components/schemas/HoolihanHeaders"}}},"HoolihanEvent":{"type":"object","required":["id","topic","value","partition","offset"],"properties":{"id":{"description":"The Hoolihan ID of the event","type":"string"},"topic":{"description":"The name of the Hoolihan topic that the event was received on","type":"string"},"value":{"description":"Value of the event, which contains the message payload from the publishing system","$ref":"#/components/schemas/HoolihanEventValue"},"partition":{"description":"The partition index that the event was received on","type":"integer"},"offset":{"description":"The offset of the event within the partition","type":"integer"}},"example":{"id":"b7fyJDj1bu5yrt82RxLX89a98a73KSqR4ptC5MRvlEoLshbgAB3emGKdjQleAMyINZcoAkM6cB7ma2aV","topic":"example_fulfillment_topic","partition":0,"offset":1234,"value":{"content":"ewogICAgImV4dGVybmFsX3JlcXVlc3RfaWQiOiAiMTIzNDUiLAogICAgInJlcXVlc3Rvcl9pZCI6ICIxMjM0NTY3ODkw\nQUJDREVGMTIzNDU2NzhAYWRvYmUuY29tIiwKICAgICJvd25lcl9pZCI6ICIxMjM0NTY3ODkwQUJDREVGMTIzNDU2NzhA\nQWRvYmVPcmciLAogICAgInJlcXVlc3RfdHlwZSI6ICJSRUdVTEFSIiwKICAgICJyZXF1ZXN0b3Jfc3lzdGVtIjogIkFB\nVUkiLAogICAgImZ1bGZpbGxtZW50X2lkIjogIjEyMzQ1Njc4OTBhYmNkZWYxMjM0NTY3ODkwYWJjZGVmMTIzNDU2Nzg5\nMGFiY2RlZjEyMzQ1Njc4OTBhYmNkZWYiLAogICAgImNyZWF0ZV9kYXRlIjogIjIwMjQtMDEtMjJUMDk6MjA6MDEuMTIz\nNDVaIiwKICAgICJpdGVtcyI6IFsKICAgICAgICB7CiAgICAgICAgICAgICJleHRlcm5hbF9pdGVtX2lkIjogIjEyMzQ1\nLWFiY2QtMTIzNC0xMjM0LTEyMzQ0MzIxIiwKICAgICAgICAgICAgInF1YW50aXR5IjogIlVOTElNSVRFRCIsCiAgICAg\nICAgICAgICJvZmZlcl9pZCI6ICIxMjM0NTY3ODkwQUJDREVGMTIzNDU2Nzg5MEFCQ0RFRiIsCiAgICAgICAgICAgICJh\nY2NlcHRlZF90ZXJtcyI6IHsKICAgICAgICAgICAgICAgICJjb250cmFjdF9pZCI6ICIxMjM0NTY3ODkwQUJDREVGMTIz\nNCIsCiAgICAgICAgICAgICAgICAiYWNjZXB0ZWRfYWdyZWVtZW50IjogIklOSVRJQUwiCiAgICAgICAgICAgIH0sCiAg\nICAgICAgICAgICJmdWxmaWxsYWJsZV9pdGVtc19jb21wbGV0ZWQiOiBbCiAgICAgICAgICAgICAgICB7CiAgICAgICAg\nICAgICAgICAgICAgImlkIjogIjEyM2U0NTY3LWU4OWItMTJkMy1hNDU2LTQyNjYxNDE3NDAwMCIsCiAgICAgICAgICAg\nICAgICAgICAgImNvZGUiOiAiZHhfZXhhbXBsZV9zb2x1dGlvbiIsCiAgICAgICAgICAgICAgICAgICAgImZ1bGZpbGxt\nZW50X2RldGFpbHMiOiB7CiAgICAgICAgICAgICAgICAgICAgICAgICJmdWxmaWxsYWJsZV9lbnRpdHlfcmVzb3VyY2Vf\nbG9jYXRvciI6ICJodHRwczovL2V4YW1wbGUuY29tLzEyMzQ1Njc4OTBBQkNERUYxMjM0NTY3OEBBZG9iZU9yZyIsCiAg\nICAgICAgICAgICAgICAgICAgICAgICJmdWxmaWxsYWJsZV9lbnRpdHlfcmVzb3VyY2VfbmFtZSI6ICJFeGFtcGxlIFNv\nbHV0aW9uIgogICAgICAgICAgICAgICAgICAgIH0KICAgICAgICAgICAgICAgIH0KICAgICAgICAgICAgXQogICAgICAg\nIH0KICAgIF0KfQ==","headers":{"x-request-id":["123e4567-e89b-12d3-a456-426614174000"],"miso-trace-id":["12345678abcdef12:12345678abcdef12:12345678abcdef12:1"],"com-adobe-hoolihan-source-partition":["0"],"com-adobe-hoolihan-source-offset":["1234"],"com-adobe-hoolihan-publish-time":["1705915000000"],"x-api-key":["example_publisher_client_id"],"com-adobe-hoolihan-publisher":["example_publisher_client_id"],"com-adobe-hoolihan-source-topic":["example_source_topic"],"com-adobe-hoolihan-on-behalf-of":["example_other_client_id"],"Content-Type":["application/json"]}}}},"HoolihanEvents":{"type":"array","items":{"$ref":"#/components/schemas/HoolihanEvent"}},"ProcessingStatus":{"type":"string","enum":["accepted","rejected"],"example":"accepted"},"FulfillmentProcessingResults":{"type":"array","items":{"type":"object","required":["status"],"properties":{"status":{"description":"The acceptance status (whether or not the event was accepted for processing)","$ref":"#/components/schemas/ProcessingStatus"},"requestId":{"description":"The request ID","$ref":"#/components/schemas/Id"}}},"example":[{"status":"accepted","requestId":"123e4567-e89b-12d3-a456-426614174000"},{"status":"rejected"}]},"CDNXForwardedHostAlert":{"type":"object","additionalProperties":true,"properties":{"forwardedHost":{"description":"value of x-forwarded-host header in the CDN log which trggered the domain discovery alert","type":"string","example":"blog.adobe.com, main--blog--adobecom.hlx.live, main--blog--adobecom.hlx.live, main--blog--adobecom.hlx-fastly.page"}}},"Domain":{"type":"string","format":"domain","example":"www.example.com"},"RUMDomainDiscoveryAlert":{"type":"object","additionalProperties":true,"properties":{"url":{"description":"URL of the page which triggered the domain discovery alert","$ref":"#/components/schemas/URL"},"domain":{"description":"Domain of the page which triggered the domain discovery alert","$ref":"#/components/schemas/Domain"}}},"AnalyticsSiteIntegration":{"type":"object","additionalProperties":true,"required":["siteId","reporting","dataCollection","dataStore","dataMapping"],"properties":{"siteId":{"description":"The site ID in uuid format","$ref":"#/components/schemas/Id"},"reporting":{"description":"The reporting details","type":"object","required":["link"],"additionalProperties":true,"properties":{"link":{"description":"The link to the report in the reporting tool.\nFor Adobe Analytics and Customer Journey Analytics, the link to the Analysis Workspace report.\n","$ref":"#/components/schemas/URL"},"timezone":{"description":"The timezone for the data in the report","type":"string"}}},"dataCollection":{"description":"The configuration for the data collection to embed on the site.","type":"object","required":["type","environments"],"properties":{"type":{"description":"The type of the data collection","type":"string","enum":["adobe-tags","aep-websdk"]},"environments":{"description":"The environments for the data collection script.\nAt least the script for the production environment is required.\nThe keys represent the environments (development, staging, production).\nThe values represent the URL or ID of the data collection script.\nFor Adobe Analytics and Customer Journey Analytics, the values are either\nURL for the Adobe Launch script or the datastream ID.\n","type":"object","additionalProperties":{"type":"string"},"required":["production"],"properties":{"production":{"description":"The URL or ID of the production data collection script","type":"string"}}}}},"dataStore":{"description":"The data store details","type":"object","required":["id","type"],"additionalProperties":true,"properties":{"id":{"description":"The ID of the data store","type":"string"},"type":{"description":"The type of the data store","type":"string","enum":["adobe-analytics","aep"]}}},"dataSchema":{"description":"The data schema details","type":"object","required":["id"],"additionalProperties":true,"properties":{"id":{"description":"The ID of the data schema","type":"string"}}},"dataMapping":{"description":"The data mapping details","type":"object","required":["type","mappings"],"properties":{"type":{"description":"The type of the data mapping","type":"string","enum":["adobe-analytics","xdm"]},"mappings":{"description":"The data mapping details. The keys represent human-friendly naming of metrics and dimensions captured by the\ninstrumentation of the site. The values represent the corresponding metric and dimension names in the data store.\nFor Adobe Analytics, the values are either evars or events.\nFor XDM, the values are the paths in the data schema.\n","type":"object","additionalProperties":{"type":"string"}}}}},"examples":[{"analytics-site-integration-aa-tags":{"$ref":"./examples.yaml#/analytics-site-integration-aa-tags"}},{"analytics-site-integration-aa-aep-websdk":{"$ref":"./examples.yaml#/analytics-site-integration-aa-aep-websdk"}},{"analytics-site-integration-cja-tags":{"$ref":"./examples.yaml#/analytics-site-integration-cja-tags"}},{"analytics-site-integration-cja-websdk":{"$ref":"./examples.yaml#/analytics-site-integration-cja-websdk"}}]},"ImsOrganizationId":{"type":"string","example":"1234567890ABCDEF12345678@AdobeOrg"},"SlackConfig":{"type":"object","additionalProperties":true,"properties":{"channel":{"description":"The Slack channel ID to send notifications to","type":"string","example":"C1234567890"},"workspace":{"description":"The Slack workspace name to send notifications to","type":"string","example":"example-workspace"},"invitedUserCount":{"description":"The number of external users invited to the Slack channel","type":"integer","example":5},"channel-url":{"description":"Slack URL of the channel to send notifications to","type":"string","example":"https://example-workspace.slack.com/archives/C1234567890"}}},"SlackMentionConfig":{"type":"object","properties":{"slack":{"type":"array","items":{"type":"string"}}}},"HandlerConfig":{"type":"object","additionalProperties":false,"properties":{"mentions":{"$ref":"#/components/schemas/SlackMentionConfig"},"excludedURLs":{"description":"URLs to be excluded from the handler's processing","type":"array","items":{"type":"string","format":"uri"}},"groupedURLs":{"description":"List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed","type":"array","items":{"type":"object","properties":{"name":{"description":"Name of the URL group","type":"string"},"pattern":{"description":"Pattern representing the URL path structure to group","type":"string"}}}}},"patternProperties":{"^(404|broken-backlinks)$":{"type":"object","properties":{"mentions":{"$ref":"#/components/schemas/SlackMentionConfig"}}}},"example":{"excludedURLs":["https://www.adobe.com/excluded-page","https://www.adobe.com/another-excluded-page"],"groupedURLs":[{"name":"catalog","pattern":"/products/"},{"name":"blog","pattern":"/post/"}]}},"Config":{"type":"object","additionalProperties":true,"properties":{"slack":{"description":"Optional. The Slack configuration","$ref":"#/components/schemas/SlackConfig"},"handlers":{"description":"Optional. The Alert configuration","$ref":"#/components/schemas/HandlerConfig"}}},"OrganizationConfig":{"allOf":[{"$ref":"#/components/schemas/Config"}]},"Organization":{"type":"object","properties":{"id":{"description":"The organization ID in uuid format","$ref":"#/components/schemas/Id"},"name":{"description":"The name of the organization","type":"string"},"imsOrgId":{"description":"Optional. The ID of the Adobe IMS organization","$ref":"#/components/schemas/ImsOrganizationId"},"config":{"description":"Optional. The configuration of the organization","$ref":"#/components/schemas/OrganizationConfig"},"createdAt":{"description":"The date and time when the organization was created","$ref":"#/components/schemas/DateTime"},"updatedAt":{"description":"The date and time when the organization was last updated","$ref":"#/components/schemas/DateTime"}},"example":{"id":"o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z","name":"Example Organization","imsOrgId":"1234567890ABCDEF12345678@AdobeOrg","config":{"slack":{"channel":"#example-channel","workspace":"example-workspace","invitedUserCount":5},"handlers":{"404":{"byOrg":true,"mentions":{"slack":["@user1","@user2"]}},"cwv":{"byOrg":false,"mentions":{"slack":["@user5","@user6"]}}}},"createdAt":"2023-12-15T09:30:00Z","updatedAt":"2024-01-19T11:20:00Z"}},"OrganizationList":{"type":"array","items":{"$ref":"#/components/schemas/Organization"}},"OrganizationCreate":{"type":"object","required":["name"],"properties":{"name":{"description":"The name of the organization","type":"string"},"imsOrgId":{"description":"Optional. The ID of the Adobe IMS organization","$ref":"#/components/schemas/ImsOrganizationId"},"config":{"description":"Optional. The configuration of the organization","$ref":"#/components/schemas/OrganizationConfig"}},"example":{"name":"Example Organization","imsOrgId":"1234567890ABCDEF12345678@AdobeOrg","config":{"slack":{"channel":"#example-channel","workspace":"example-workspace"},"handlers":{"404":{"mentions":{"slack":["@user3","@user4"]}},"cwv":{"byOrg":false,"mentions":{"slack":["@user5","@user6"]}}}}}},"OrganizationUpdate":{"type":"object","properties":{"name":{"description":"The name of the organization","type":"string"},"imsOrgId":{"description":"Optional. The ID of the Adobe IMS organization","$ref":"#/components/schemas/ImsOrganizationId"},"config":{"description":"Optional. The configuration of the organization","$ref":"#/components/schemas/OrganizationConfig"}},"example":{"name":"Example Organization","imsOrgId":"1234567890ABCDEF12345678@AdobeOrg","config":{"slack":{"channel":"#example-channel","workspace":"example-workspace","handlers":{"404":{"mentions":{"slack":["@user3","@user4"]}},"cwv":{"mentions":{"slack":["@user5","@user6"]}}}}}}},"SiteConfig":{"allOf":[{"$ref":"#/components/schemas/Config"}]},"Site":{"type":"object","properties":{"id":{"description":"The site ID in uuid format","$ref":"#/components/schemas/Id"},"organizationId":{"description":"The optional ID of the organization this site belongs to","$ref":"#/components/schemas/Id"},"baseURL":{"description":"The base URL of the site","$ref":"#/components/schemas/URL"},"deliveryType":{"description":"The type of the delivery this site is using","$ref":"#/components/schemas/DeliveryType"},"gitHubURL":{"description":"The optional GitHub URL of the site","$ref":"#/components/schemas/URL"},"goLiveDate":{"description":"The date and time when the site went live on AEM Edge","nullable":true,"$ref":"#/components/schemas/DateTime"},"config":{"description":"Optional. The configuration of the site. May override the organization configuration.","$ref":"#/components/schemas/SiteConfig"},"createdAt":{"description":"The date and time when the site was created","$ref":"#/components/schemas/DateTime"},"updatedAt":{"description":"The date and time when the site was last updated","$ref":"#/components/schemas/DateTime"}},"example":{"id":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","organizationId":"o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z","baseURL":"https://example-site.com","deliveryType":"aem_edge","gitHubURL":"https://github.com/example/repo","goLiveDate":"2024-01-20T10:00:00Z","config":{"slack":{"channel":"C1234567890","workspace":"example-workspace"},"handlers":{"404":{"mentions":{"slack":["@user1","@user2"]}},"broken-backlinks":{"mentions":{"slack":["@user5","@user6"]},"excludedURLs":{"description":"URLs to be excluded from the alert","type":"array","items":{"type":"string","format":"uri'"}},"groupedURLs":{"description":"List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed","type":"array","items":{"type":"object","properties":{"name":{"description":"Name of the URL group","type":"string"},"pattern":{"description":"Pattern representing the URL path structure to group","type":"string"}}}}}}},"createdAt":"2023-12-15T09:30:00Z","updatedAt":"2024-01-19T11:20:00Z"}},"SiteList":{"type":"array","items":{"$ref":"#/components/schemas/Site"}},"ImportOptions":{"type":"object","properties":{"pageLoadTimeout":{"description":"The time in milliseconds to wait for the page to load","type":"integer"},"enableJavascript":{"description":"Whether to enable JavaScript on the page","type":"boolean"}},"example":{"pageLoadTimeout":100,"enableJavascript":true}},"ScrapeRequest":{"type":"object","required":["urls"],"properties":{"jobId":{"description":"Optional ID of the scrape job","$ref":"#/components/schemas/Id"},"options":{"description":"Optional configuration params, defined as a JSON object","$ref":"#/components/schemas/ImportOptions"},"customHeaders":{"description":"Optional custom headers to send with each HTTP request","type":"object"},"urls":{"description":"The URLs to scrape. The URLs must be unique. Limit of 10 URLs per request.","type":"array","items":{"type":"object","properties":{"url":{"description":"The URL to scrape","$ref":"#/components/schemas/URL"}}},"example":{"urls":[{"url":"https://example.com/en/page1"},{"url":"https://example.com/fr/page2"}]}}}},"ScrapeResult":{"type":"array","items":{"type":"object","properties":{"url":{"description":"The URL of the scraped page","$ref":"#/components/schemas/URL"},"status":{"description":"The status of the scrape job","type":"string","enum":["COMPLETE","FAILED"]},"content":{"description":"The content of the scraped page","type":"string"},"error":{"description":"The error message if the scrape failed","type":"string"}},"example":[{"url":"https://example.com/en/page1","status":"COMPLETE","content":"<body>...</body>"},{"url":"https://example.com/fr/page2","status":"FAILED","error":"Timeout"}]}},"ScrapeResponse":{"type":"object","properties":{"id":{"description":"The ID of the scrape job","$ref":"#/components/schemas/Id"},"status":{"description":"The status of the scrape job","type":"string","enum":["COMPLETE","FAILED"]},"startTime":{"description":"The date and time when the scrape job started","$ref":"#/components/schemas/DateTime"},"endTime":{"description":"The date and time when the scrape job ended, if finished","$ref":"#/components/schemas/DateTime"},"urlCount":{"description":"The total number of URLs in the job","type":"integer"},"successCount":{"description":"The number of URLs successfully scraped","type":"integer"},"failedCount":{"description":"The number of URLs that failed to scrape","type":"integer"},"results":{"description":"The scrape results","type":"array","items":{"$ref":"#/components/schemas/ScrapeResult"}}},"example":{"id":"12d6ac8e-d5e4-4788-90eb-b69e10e745fd","status":"COMPLETE","startTime":"2024-01-19T14:20:30Z","urlCount":10,"successCount":9,"failedCount":1,"results":[{"url":"https://example.com/en/page1","status":"COMPLETE","content":"..."},{"url":"https://example.com/fr/page2","status":"FAILED","error":"..."}]}},"SiteCreate":{"type":"object","required":["baseURL","deliveryType"],"properties":{"organizationId":{"description":"The optional ID of the organization this site belongs to","default":null,"$ref":"#/components/schemas/Id"},"baseURL":{"description":"The base URL of the site","$ref":"#/components/schemas/URL"},"deliveryType":{"description":"The type of the delivery this site is using","$ref":"#/components/schemas/DeliveryType"},"gitHubURL":{"description":"The optional GitHub URL of the site","$ref":"#/components/schemas/URL"},"goLiveDate":{"description":"The date and time when the site went live on AEM Edge","nullable":true,"$ref":"#/components/schemas/DateTime"}},"example":{"organizationId":"o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z","baseURL":"https://www.newsite.com","deliveryType":"aem_cs"}},"SiteWithLatestAudit":{"allOf":[{"$ref":"#/components/schemas/Site"},{"type":"object","properties":{"audits":{"description":"An array with the latest audit for the given audit type","type":"array","items":{"$ref":"#/components/schemas/Audit"}}}}],"example":{"id":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","organizationId":"o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z","baseURL":"https://example-site.com","deliveryType":"aem_edge","gitHubURL":"https://github.com/example/repo","goLiveDate":"2024-01-20T10:00:00Z","createdAt":"2023-12-15T09:30:00Z","updatedAt":"2024-01-19T11:20:00Z","audits":[{"siteId":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","auditedAt":"2024-01-20T12:00:00Z","expiresAt":"2024-07-20T12:00:00Z","auditType":"cwv","isError":false,"deliveryType":"aem_edge","fullAuditRef":"https://some-audit-system/full-report/1234","auditResult":{"someProperty":"someValue"},"previousAuditResult":{"someProperty":"somePreviousValue"}}]}},"SiteWithLatestAuditList":{"type":"array","items":{"$ref":"#/components/schemas/SiteWithLatestAudit"}},"SiteUpdate":{"type":"object","properties":{"organizationId":{"description":"The optional ID of the organization this site belongs to","$ref":"#/components/schemas/Id"},"deliveryType":{"description":"The type of the delivery this site is using","$ref":"#/components/schemas/DeliveryType"},"goLiveDate":{"description":"The date and time when the site went live on AEM Edge","nullable":true,"$ref":"#/components/schemas/DateTime"},"config":{"description":"Optional. The configuration of the site","$ref":"#/components/schemas/SiteConfig"}},"example":{"organizationId":"u7y6t5r4-e3w2-x1z0-z9y8-x7v6w5u4t3s2","deliveryType":"other","goLiveDate":"2024-01-20T10:00:00Z"}},"UpdateHandlerTypeConfig":{"type":"object","properties":{"excludedURLs":{"description":"Set of URLs to exclude. If empty, previously excluded URLs will be removed","type":"array","items":{"type":"string"}},"groupedURLs":{"description":"List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed","type":"array","items":{"type":"object","properties":{"name":{"description":"Name of the URL group","type":"string"},"pattern":{"description":"Pattern representing the URL path structure to group","type":"string"}}}}},"example":{"excludedURLs":["https://www.adobe.com/some-page","https://www.adobe.com/another-page"],"groupedURLs":[{"name":"catalog","pattern":"/products/"},{"name":"blog","pattern":"/post/"}]}},"OpportunityType":{"description":"Type of opportunity","type":"string","enum":["broken-backlinks","broken-internal-links"],"example":"broken-backlinks"},"BrokenBacklinksOpportunityData":{"description":"Data specific to broken backlinks opportunity","type":"object","additionalProperties":true},"BrokenInternalLinksOpportunityData":{"description":"Data specific to broken internal links opportunity","type":"object","properties":{"projectedTrafficLost":{"type":"number","description":"Projected Traffic Lost, representing the estimated loss of organic traffic"},"projectedTrafficValue":{"type":"number","description":"Projected Traffic Value, calculated by multiplying the Projected Traffic Lost by the Cost Per Click (CPC) value."}},"additionalProperties":true},"CWVOpportunityData":{"description":"Data specific to Core Web Vitals improvements opportunity","type":"object","properties":{"projectedTrafficLost":{"type":"number","description":"Projected Traffic Lost, representing the estimated loss of organic traffic"},"projectedTrafficValue":{"type":"number","description":"Projected Traffic Value, calculated by multiplying the Projected Traffic Lost by the Cost Per Click (CPC) value."}},"additionalProperties":true},"OpportunityOrigin":{"description":"Origin of opportunity.\n- AUTOMATION: generated by automation\n- ESS_OPS: generated manually by Experience Success Engineers\n- AI: generated by AI\n","type":"string","enum":["AUTOMATION","ESS_OPS","AI"],"example":"ESS_OPS"},"OpportunityStatus":{"description":"Status of an opportunity","type":"string","enum":["NEW","IN_PROGRESS","IGNORED","RESOLVED"],"example":"IN_PROGRESS"},"BrokenBacklinksGuidance":{"description":"Guidance specific to broken backlinks opportunity","type":"object","additionalProperties":true,"properties":{"steps":{"description":"The steps to resolve the broken backlinks opportunity","type":"array","items":{"type":"string"}}}},"BrokenInternalLinksGuidance":{"description":"Guidance specific to broken internal links opportunity","type":"object","additionalProperties":true,"properties":{"steps":{"description":"The steps to resolve the broken internal links opportunity","type":"array","items":{"type":"string"}}}},"CWVGuidance":{"description":"Guidance specific to Core Web Vitals improvements opportunity","type":"object","additionalProperties":true,"properties":{"steps":{"description":"The recommended steps to resolve Core Web Vitals issues and improve site performance.","type":"array","items":{"type":"string"}}}},"Opportunity":{"type":"object","properties":{"id":{"description":"UUID of this opportunity","$ref":"#/components/schemas/Id"},"siteId":{"description":"UUID of the site this opportunity is for","$ref":"#/components/schemas/Id"},"auditId":{"description":"UUID of the audit result that triggered this opportunity","$ref":"#/components/schemas/Id"},"runbook":{"description":"URL to the runbook for this opportunity","type":"string","format":"url","example":"https://example.com/runbook/broken-backlinks"},"type":{"$ref":"#/components/schemas/OpportunityType"},"data":{"description":"Optional map of type-specific data relevant to this opportunity","type":"object","additionalProperties":true,"oneOf":[{"$ref":"#/components/schemas/BrokenBacklinksOpportunityData"},{"$ref":"#/components/schemas/BrokenInternalLinksOpportunityData"},{"$ref":"#/components/schemas/CWVOpportunityData"}]},"origin":{"$ref":"#/components/schemas/OpportunityOrigin"},"title":{"description":"Title of this opportunity","type":"string","example":"Authoritative domains are linking to invalid SecurBank URLs. This could impact your SEO."},"description":{"description":"Description of this opportunity","type":"string","example":"Provide the correct target URL that each of the broken backlinks should be redirected to."},"status":{"description":"Status of this opportunity","$ref":"#/components/schemas/OpportunityStatus"},"guidance":{"description":"Guidance text specific to this opportunity","type":"object","additionalProperties":true,"oneOf":[{"$ref":"#/components/schemas/BrokenBacklinksGuidance"},{"$ref":"#/components/schemas/BrokenInternalLinksGuidance"},{"$ref":"#/components/schemas/CWVGuidance"}]},"tags":{"type":"array","items":{"type":"string"},"description":"Optional list of tags","example":["Traffic acquisition"]},"createdAt":{"description":"UTC timestamp of when the opportunity was created","$ref":"#/components/schemas/DateTime"},"updatedAt":{"description":"UTC timestamp of when the opportunity was last updated","$ref":"#/components/schemas/DateTime"}},"required":["id","siteId","auditId","runbook","type","origin","title","status","createdAt","updatedAt"]},"OpportunityList":{"type":"array","items":{"$ref":"#/components/schemas/Opportunity"}},"OpportunityCreate":{"type":"object","properties":{"auditId":{"description":"UUID of the audit result that triggered this opportunity","readOnly":false,"$ref":"#/components/schemas/Id"},"runbook":{"description":"URL to the runbook for this opportunity","type":"string","format":"url","example":"https://example.com/runbook/broken-backlinks"},"type":{"$ref":"#/components/schemas/OpportunityType"},"data":{"description":"Optional map of type-specific data relevant to this opportunity","type":"object","additionalProperties":true,"oneOf":[{"$ref":"#/components/schemas/BrokenBacklinksOpportunityData"},{"$ref":"#/components/schemas/BrokenInternalLinksOpportunityData"}]},"origin":{"description":"Origin of opportunity","$ref":"#/components/schemas/OpportunityOrigin"},"title":{"description":"Title of this opportunity","type":"string","example":"Authoritative domains are linking to invalid SecurBank URLs. This could impact your SEO."},"description":{"description":"Description of this opportunity","type":"string","example":"Provide the correct target URL that each of the broken backlinks should be redirected to."},"guidance":{"description":"Guidance text specific to this opportunity","type":"object","additionalProperties":true,"oneOf":[{"$ref":"#/components/schemas/BrokenBacklinksGuidance"},{"$ref":"#/components/schemas/BrokenInternalLinksGuidance"}]},"tags":{"type":"array","items":{"type":"string"},"description":"Optional list of tags","example":["Traffic acquisition"]}},"required":["auditId","runbook","type","origin","title"]},"OpportunityUpdate":{"type":"object","properties":{"runbook":{"description":"URL to the runbook for this opportunity","type":"string","format":"url","example":"https://example.com/runbook/broken-backlinks"},"data":{"description":"Optional map of type-specific data relevant to this opportunity","type":"object","additionalProperties":true,"oneOf":[{"$ref":"#/components/schemas/BrokenBacklinksOpportunityData"},{"$ref":"#/components/schemas/BrokenInternalLinksOpportunityData"}]},"title":{"description":"Title of this opportunity","type":"string","example":"Authoritative domains are linking to invalid SecurBank URLs. This could impact your SEO."},"description":{"description":"Description of this opportunity","type":"string","example":"Provide the correct target URL that each of the broken backlinks should be redirected to."},"status":{"description":"Status of this opportunity","$ref":"#/components/schemas/OpportunityStatus"},"guidance":{"description":"Guidance text specific to this opportunity","type":"object","additionalProperties":true,"oneOf":[{"$ref":"#/components/schemas/BrokenBacklinksGuidance"},{"$ref":"#/components/schemas/BrokenInternalLinksGuidance"}]},"tags":{"type":"array","items":{"type":"string"},"description":"Optional list of tags","example":["Traffic acquisition"]}}},"SuggestionType":{"description":"Type of suggestion:\n- REDIRECT_UPDATE: Add or update a redirect as suggested\n- EXPERIMENT: Run the experiment with the given suggestions\n- CONTENT_UPDATE: Update the content to the suggested\n- METADATA_UPDATE: Update the metadata to the suggested\n","type":"string","enum":["REDIRECT_UPDATE","EXPERIMENT","CONTENT_UPDATE","METADATA_UPDATE"],"example":"REDIRECT_UPDATE"},"BrokenBacklinksRedirectData":{"description":"Data specific to redirect suggestion for broken backlinks opportunity","type":"object","additionalProperties":true,"properties":{"title":{"description":"The title of the referring page","type":"string"},"url_from":{"description":"The URL of the referring page","type":"string"},"url_to":{"description":"The URL of the broken target page","type":"string"},"urls_suggested":{"description":"The proposed target URLs to redirect the broken backlink to","type":"array","items":{"type":"string"}},"manualOverrideURL":{"description":"The URL to manually override the proposed target URL","type":"string"},"traffic_domain":{"description":"The estimated monthly organic traffic to the referring page","type":"number"}}},"BrokenInternalLinksSuggestionData":{"description":"Data specific to redirect suggestion for broken internal links opportunity","type":"object","additionalProperties":true,"properties":{"title":{"description":"The title of the referring page","type":"string"},"urlFrom":{"description":"The URL of the referring page","type":"string"},"urlTo":{"description":"The URL of the broken target page","type":"string"},"aiRationale":{"description":"The rationale for the suggested fix","type":"string"},"urlsSuggested":{"description":"The proposed internal target URLs to point the broken internal link to","type":"array","items":{"type":"string"}},"manualOverrideURL":{"description":"The URL to manually override the proposed target URL","type":"string"},"trafficDomain":{"description":"The estimated monthly organic traffic to the referring page","type":"number"},"priority":{"description":"The priority of the broken internal link","$ref":"#/components/schemas/Priority"}}},"BrokenBacklinksKpiDeltas":{"description":"KPI deltas specific to redirect suggestion for broken backlinks opportunity","type":"object","additionalProperties":true},"BrokenInternalLinksKpiDeltas":{"description":"KPI deltas specific to redirect suggestion for broken internal links opportunity","type":"object","additionalProperties":true},"SuggestionStatus":{"description":"Status of this suggestion; status reflects overall fix execution, flagged here for optimization","type":"string","enum":["NEW","APPROVED","SKIPPED","FIXED","ERROR"],"example":"NEW"},"Suggestion":{"type":"object","properties":{"id":{"description":"UUID of this suggestion","$ref":"#/components/schemas/Id"},"opportunityId":{"description":"UUID of the opportunity this suggestion belongs to","$ref":"#/components/schemas/Id"},"type":{"$ref":"#/components/schemas/SuggestionType"},"rank":{"description":"Type-specific numeric rank value (e.g., \"domainTraffic\" for a broken-backlink) helps sorting","type":"number","example":45600},"data":{"description":"Map containing type-specific details of what fix is suggested","type":"object","additionalProperties":true,"oneOf":[{"$ref":"#/components/schemas/BrokenBacklinksRedirectData"},{"$ref":"#/components/schemas/BrokenInternalLinksSuggestionData"}]},"kpiDeltas":{"description":"Map containing metrics estimated to experience lifts or losses due to the issue","type":"object","additionalProperties":true,"oneOf":[{"$ref":"#/components/schemas/BrokenBacklinksKpiDeltas"},{"$ref":"#/components/schemas/BrokenInternalLinksKpiDeltas"}]},"status":{"description":"Status of this suggestion; status reflects overall fix execution, flagged here for optimization","$ref":"#/components/schemas/SuggestionStatus"},"createdAt":{"description":"UTC timestamp of when the suggestion was created","$ref":"#/components/schemas/DateTime"},"updatedAt":{"description":"UTC timestamp of when the suggestion was last updated","$ref":"#/components/schemas/DateTime"}},"required":["id","opportunityId","type","rank","data","status","createdAt","updatedAt"]},"SuggestionList":{"type":"array","items":{"$ref":"#/components/schemas/Suggestion"}},"SuggestionCreate":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/SuggestionType"},"rank":{"description":"Type-specific numeric rank value (e.g., \"domainTraffic\" for a broken-backlink) helps sorting","type":"number","example":45600},"data":{"description":"Map containing type-specific details of what fix is suggested","type":"object","additionalProperties":true,"oneOf":[{"$ref":"#/components/schemas/BrokenBacklinksRedirectData"},{"$ref":"#/components/schemas/BrokenInternalLinksSuggestionData"}]},"kpiDeltas":{"description":"Map containing metrics estimated to experience lifts or losses due to the issue","type":"object","additionalProperties":true,"oneOf":[{"$ref":"#/components/schemas/BrokenBacklinksKpiDeltas"},{"$ref":"#/components/schemas/BrokenInternalLinksKpiDeltas"}]}},"required":["opportunityId","type","rank","data"]},"SuggestionCreateList":{"type":"array","items":{"$ref":"#/components/schemas/SuggestionCreate"}},"SuggestionOperationSuccess":{"type":"object","description":"Success response for a suggestion operation","properties":{"index":{"description":"Index of this suggestion in the list from the request body, starting from 0","type":"integer","minimum":0},"statusCode":{"description":"HTTP status code indicating the type of success","type":"integer"},"suggestion":{"$ref":"#/components/schemas/Suggestion"}},"required":["index","statusCode","suggestion"]},"SuggestionCreateFailure":{"type":"object","description":"Suggestion create failure response","properties":{"index":{"description":"Index of this suggestion in the list from the request body, starting from 0","type":"integer","minimum":0},"statusCode":{"description":"HTTP status code indicating the type of failure","type":"integer"},"message":{"description":"Error message describing the failure","type":"string"}},"required":["index","statusCode","message"]},"SuggestionCreateListResponse":{"type":"object","description":"Suggestion create list response","properties":{"suggestions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/SuggestionOperationSuccess"},{"$ref":"#/components/schemas/SuggestionCreateFailure"}]}},"metadata":{"type":"object","properties":{"total":{"description":"Total number of suggestions in the response","type":"integer"},"success":{"description":"Number of suggestions successfully create","type":"integer"},"failure":{"description":"Number of suggestions that failed to create","type":"integer"}},"required":["total","success","failure"]}},"required":["suggestions","metadata"]},"SuggestionUpdate":{"type":"object","properties":{"rank":{"description":"Type-specific numeric rank value (e.g., \"domainTraffic\" for a broken-backlink) helps sorting","type":"number","example":12300},"data":{"description":"Map containing type-specific details of what fix is suggested","type":"object","additionalProperties":true,"oneOf":[{"$ref":"#/components/schemas/BrokenBacklinksRedirectData"},{"$ref":"#/components/schemas/BrokenInternalLinksSuggestionData"}]},"kpiDeltas":{"description":"Map containing metrics estimated to experience lifts or losses due to the issue","type":"object","additionalProperties":true,"oneOf":[{"$ref":"#/components/schemas/BrokenBacklinksKpiDeltas"},{"$ref":"#/components/schemas/BrokenInternalLinksKpiDeltas"}]}}},"SuggestionStatusUpdate":{"type":"array","items":{"type":"object","properties":{"id":{"description":"UUID of this suggestion","readOnly":false,"$ref":"#/components/schemas/Id"},"status":{"description":"Status of this suggestion; status reflects overall fix execution, flagged here for optimization","$ref":"#/components/schemas/SuggestionStatus"}},"required":["id","status"]}},"SuggestionUpdateFailure":{"type":"object","description":"Suggestion update failure","properties":{"id":{"description":"UUID of this suggestion","$ref":"#/components/schemas/Id"},"index":{"description":"Index of this suggestion in the list from the request body, starting from 0","type":"integer","minimum":0},"statusCode":{"description":"HTTP status code indicating the type of failure","type":"integer"},"message":{"description":"Error message describing the failure","type":"string"}},"required":["id","index","statusCode","message"]},"SuggestionStatusUpdateListResponse":{"type":"object","description":"Suggestions status update response","properties":{"suggestions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/SuggestionOperationSuccess"},{"$ref":"#/components/schemas/SuggestionUpdateFailure"}]}},"metadata":{"type":"object","properties":{"total":{"description":"Total number of suggestions in the response","type":"integer"},"success":{"description":"Number of suggestions successfully updated","type":"integer"},"failure":{"description":"Number of suggestions that failed to update","type":"integer"}},"required":["total","success","failure"]}},"required":["suggestions","metadata"]},"KeyEventType":{"type":"string","enum":["performance","seo","content","code","third party","experimentation","network","status change"]},"KeyEvent":{"type":"object","properties":{"id":{"description":"The key event ID in uuid format","$ref":"#/components/schemas/Id"},"name":{"description":"Name of the key event","type":"string"},"type":{"$ref":"#/components/schemas/KeyEventType"},"time":{"description":"Time of the key event occurred","$ref":"#/components/schemas/DateTime"}},"example":{"id":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","name":"Multiple 404s detected","type":"seo","time":"2023-12-15T09:30:00Z"}},"KeyEventsList":{"type":"array","items":{"$ref":"#/components/schemas/KeyEvent"}},"KeyEventCreate":{"type":"object","required":["name","type"],"properties":{"name":{"description":"Name of the key event","type":"string"},"type":{"$ref":"#/components/schemas/KeyEventType"},"time":{"description":"Time of the key event occurred (optional). Current time is used when the field is missing","$ref":"#/components/schemas/DateTime"}}},"SiteTopPage":{"type":"object","required":["siteId","url","traffic","source","geo","importedAt"],"properties":{"siteId":{"description":"The site ID in uuid format","$ref":"#/components/schemas/Id"},"url":{"description":"The URL of the top page","$ref":"#/components/schemas/URL"},"traffic":{"description":"The traffic of the top page","type":"integer"},"source":{"description":"The source of the top page listing","type":"string"},"geo":{"description":"The geo of the top page listing, or 'global' if not specific to a geo","type":"string"},"importedAt":{"description":"The date and time when the top page was imported","$ref":"#/components/schemas/DateTime"}},"example":{"siteId":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","url":"https://example-site.com/foo/bar","traffic":360420000,"source":"ahrefs","geo":"au","importedAt":"2024-04-29T15:14:33.653Z"}},"SiteTopPageList":{"type":"array","items":{"$ref":"#/components/schemas/SiteTopPage"}},"SiteMetric":{"type":"object","required":["siteId","source","name","value","time"],"properties":{"siteId":{"description":"The site ID in uuid format","$ref":"#/components/schemas/Id"},"source":{"description":"The source for retrieving the metric value","type":"string"},"name":{"description":"The name of the metric","type":"string"},"value":{"description":"The value of the metric","type":"integer"},"time":{"description":"The date and time when the metric was recorded","$ref":"#/components/schemas/DateTime"}},"example":{"siteId":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","source":"ahrefs","name":"organic-traffic","value":37900,"time":"2024-04-29T00:00:00.000Z"}},"SiteMetricList":{"type":"array","items":{"$ref":"#/components/schemas/SiteMetric"}},"PageOrganicKeywords":{"type":"object","required":["siteId","source","name","time","url","keyword","traffic"],"properties":{"siteId":{"description":"The site ID in uuid format","$ref":"#/components/schemas/Id"},"source":{"description":"The source for retrieving the metric value","type":"string"},"name":{"description":"The name of the metric","type":"string"},"time":{"description":"The date and time when the metric was recorded","$ref":"#/components/schemas/DateTime"},"url":{"description":"The URL of the page","$ref":"#/components/schemas/URL"},"keyword":{"description":"The keyword","type":"string"},"traffic":{"description":"The traffic of the keyword","type":"integer"},"volume":{"description":"The search volume of the keyword","type":"integer"},"bestPosition":{"description":"The best position of the keyword","type":"integer"},"cpc":{"description":"The cost per click of the keyword","type":"integer"},"isBranded":{"description":"Whether the keyword is branded","type":"boolean"}},"example":{"siteId":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","source":"ahrefs","name":"organic-traffic","time":"2024-04-29T00:00:00.000Z","url":"https://example.com/foo/bar","keyword":"foo bar example","traffic":"2355,","volume":"2400,","bestPosition":"1,","cpc":"89,","isBranded":true}},"PageMetricList":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/PageOrganicKeywords"}]}},"SiteExperimentVariant":{"type":"object","properties":{"name":{"description":"The name of the variant","type":"string"},"label":{"description":"The label of the variant","type":"string"},"split":{"description":"The split allocation of the traffic to the variant","type":"number"},"url":{"description":"The url of the variant","$ref":"#/components/schemas/URL"},"views":{"description":"The number of views for the variant","type":"integer"},"samples":{"description":"The number of data points (samples) used for this variant","type":"integer"},"interactionsCount":{"description":"The interactions count for the variant","type":"integer"},"p_value":{"description":"The p-value of the variant for the configured metric or clicks","type":"number"},"power":{"description":"The power of the variant for the configured metric or clicks","type":"number"},"statsig":{"description":"The statistical significance of the variant based on the configured metric or clicks","type":"boolean"},"metrics":{"description":"The metrics for the variant","type":"array","items":{"type":"object","properties":{"selector":{"description":"The css selector of the element on which the interaction was performed","type":"string"},"value":{"description":"The value of the metric on the selector","type":"number"},"samples":{"description":"The number of data points (samples) used for calculating this metric object","type":"integer"},"type":{"description":"The type of the metric","type":"string","enum":["click","convert","formsubmit"]}}}}},"example":{"name":"challenger-1","label":"Challenger 1","split":0.5,"url":"https://example-site.com/foo/bar","views":1000,"samples":10,"interactionsCount":200,"p_value":0.04,"power":97.6,"statsig":true,"metrics":[{"selector":".add-to-cart","value":300,"samples":3,"type":"click"}]}},"SiteExperiment":{"type":"object","properties":{"siteId":{"description":"The site ID in uuid format","$ref":"#/components/schemas/Id"},"experimentId":{"description":"The ID of the experiment","type":"string"},"name":{"description":"The name of the experiment","type":"string"},"url":{"description":"The URL of the experiment","$ref":"#/components/schemas/URL"},"status":{"description":"The status of the experiment","type":"string","enum":["ACTIVE","COMPLETE","INACTIVE"]},"type":{"description":"The type of the experiment","type":"string","enum":["FULL","AB","MAB"]},"startDate":{"description":"The start date and time of the experiment","$ref":"#/components/schemas/DateTime"},"endDate":{"description":"The end date and time of the experiment","$ref":"#/components/schemas/DateTime"},"variants":{"description":"The variants of the experiment","type":"array","items":{"$ref":"#/components/schemas/SiteExperimentVariant"}},"updatedAt":{"description":"The date and time when the experiment was last updated","$ref":"#/components/schemas/DateTime"},"updatedBy":{"description":"The user/entity who last updated the experiment","type":"string"},"conversionEventName":{"description":"The name of the conversion event","type":"string"},"conversionEventValue":{"description":"The name of conversion event value","type":"string"}},"example":{"siteId":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","experimentId":"1012-home-page-optimization","name":"1012 Home Page Optimization","url":"https://example-site.com/foo/bar","type":"AB","status":"ACTIVE","startDate":"2024-04-29T15:14:33.653Z","endDate":"2024-05-29T15:14:33.653Z","variants":[{"name":"challenger-1","label":"Challenger 1","split":0.5,"url":"https://example-site.com/foo/bar","views":1000,"samples":10,"interactionsCount":200,"p_value":0.04,"power":97.6,"statsig":true,"metrics":[{"selector":".add-to-cart","value":300,"samples":3,"type":"click"}]}],"updatedAt":"2024-05-31T15:14:33.653Z","updatedBy":"admin","conversionEventName":"click","conversionEventValue":".add-to-cart"}},"SiteExperimentList":{"type":"array","items":{"$ref":"#/components/schemas/SiteExperiment"}},"ImsUserAccessToken":{"type":"string","example":"eyJhbGciOiJIUzI1NiJ9.eyJpZCI6IjEyMzQ1IiwidHlwZSI6ImFjY2Vzc190b2tlbiIsImNsaWVudF9pZCI6ImV4YW1wbGVfYXBwIiwidXNlcl9pZCI6Ijk4NzY1NDc4OTBBQkNERUYxMjM0NTY3OEBhYmNkZWYxMjM0NTY3ODkuZSIsImFzIjoiaW1zLW5hMSIsImFhX2lkIjoiMTIzNDU2Nzg5MEFCQ0RFRjEyMzQ1Njc4QGFkb2JlLmNvbSIsImNyZWF0ZWRfYXQiOiIxNzEwMjQ3MDAwMDAwIn0.MRDpxgxSHDj4DmA182hPnjMAnKkly-VUJ_bXpQ-J8EQ"},"SlackInviteToChannelByUserIdRequest":{"type":"object","required":["imsOrgId","imsUserAccessToken"],"properties":{"imsOrgId":{"description":"The ID of the Adobe IMS organization","$ref":"#/components/schemas/ImsOrganizationId"},"imsUserAccessToken":{"description":"The IMS access token of the user to invite to the Slack channel","$ref":"#/components/schemas/ImsUserAccessToken"}}},"ScopeName":{"type":"string","enum":["imports.write","imports.read","imports.assistant"]},"ApiKeyMetadataResponse":{"type":"object","properties":{"id":{"description":"The ID of the API key","$ref":"#/components/schemas/Id"},"name":{"description":"The name of the API key","type":"string"},"scopes":{"description":"The scopes of the API key","type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the scope","type":"string","$ref":"#/components/schemas/ScopeName"},"domains":{"description":"The domains the scope is allowed to access","type":"array","items":{"$ref":"#/components/schemas/Domain"}}}}},"createdAt":{"description":"The date and time when the API key was created","$ref":"#/components/schemas/DateTime"},"expiresAt":{"description":"The date and time when the API key expires","$ref":"#/components/schemas/DateTime"},"deletedAt":{"description":"The date and time when the API key was deleted","$ref":"#/components/schemas/DateTime"},"revokedAt":{"description":"The date and time when the API key was revoked","$ref":"#/components/schemas/DateTime"}}},"ApiKeyRequest":{"type":"object","required":["name","features","domains"],"properties":{"name":{"description":"The name of the API key","type":"string"},"features":{"description":"The features the API key is for","type":"array","items":{"type":"string"}},"domains":{"description":"The domains the API key is allowed to access","type":"array","items":{"type":"string","$ref":"#/components/schemas/Domain"}}},"example":{"name":"Example API Key","features":["imports"],"domains":["example.com"]}},"ApiKeyResponse":{"allOf":[{"$ref":"#/components/schemas/ApiKeyMetadataResponse"},{"type":"object","properties":{"apiKey":{"description":"The API key","type":"string"}}}]},"ImportJobRequest":{"type":"object","required":["urls"],"properties":{"urls":{"description":"The URLs to import","type":"array","items":{"$ref":"#/components/schemas/URL"}},"options":{"description":"Optional configuration params, defined as a JSON object","$ref":"#/components/schemas/ImportOptions"},"importScript":{"description":"Optional import.js mapping file","type":"string","format":"binary"},"customHeaders":{"description":"Optional custom headers to send with each HTTP request","type":"object"}},"example":{"urls":["https://example.com/en/page1","https://example.com/fr/page2"],"options":{"enableJavascript":true},"importScript":"(binary data)","customHeaders":{"example-header-name":"example-header-value"}}},"ImportJobStatus":{"type":"object","properties":{"id":{"description":"The ID of the import job","$ref":"#/components/schemas/Id"},"status":{"description":"The status of the import job","type":"string","enum":["RUNNING","COMPLETE","FAILED"]},"startTime":{"description":"The date and time when the import job started.","$ref":"#/components/schemas/DateTime"},"endTime":{"description":"The date and time when the import job ended, if finished.","$ref":"#/components/schemas/DateTime"},"urlCount":{"description":"The total number of URLs in the job.","type":"integer"},"successCount":{"description":"The number of URLs successfully imported.","type":"integer"},"failedCount":{"description":"The number of URLs that failed to import.","type":"integer"},"redirectCount":{"description":"The number of URLs that were redirected.","type":"integer"}},"example":{"id":"12d6ac8e-d5e4-4788-90eb-b69e10e745fd","status":"RUNNING","startTime":"2024-01-19T14:20:30Z","urlCount":25,"successCount":15,"failedCount":0}},"ImportJobStopRequest":{"type":"object","properties":{"op":{"description":"The operation to perform on the import job","type":"string","enum":["replace"]},"path":{"description":"The path of the attribute to update","type":"string","example":"/status"},"value":{"description":"The value to set","type":"string","enum":["STOPPED"]}}},"ImportJobProgress":{"type":"object","properties":{"pending":{"type":"integer","description":"The number of pending url jobs still to process."},"redirect":{"type":"integer","description":"The number of urls that resulted in a redirect."},"running":{"type":"integer","description":"The number of url jobs that are running."},"completed":{"type":"integer","description":"The number of url jobs that have completed."},"failed":{"type":"integer","description":"The number of url jobs that have failed."}},"example":{"pending":0,"redirect":0,"running":0,"completed":1,"failed":0}},"ImportJobArchive":{"type":"object","properties":{"jobId":{"description":"The ID of the import job","$ref":"#/components/schemas/Id"},"downloadUrl":{"description":"The pre-signed URL to download the archive of the import job","$ref":"#/components/schemas/URL"}},"example":{"jobId":"12d6ac8e-d5e4-4788-90eb-b69e10e745fd","downloadUrl":"https://spacecat-example-bucket.s3.example-region.amazonaws.com/import/12d6ac8e-d5e4-4788-90eb-b69e10e745fd/import-result.zip?X-Amz-Algorithm=AWS..."}},"ImportAssistantRequest":{"type":"object","required":["command"],"properties":{"command":{"description":"Assistant command to execute. Examples 'findMainContent', 'findRemovalSelectors', 'findBlockSelectors', 'findBlockCells', 'generatePageTransformation'.","type":"string"},"prompt":{"description":"Optional prompt to provide context for the analysis. It is required for all commands except 'findMainContent'.","type":"string"},"htmlContent":{"description":"The HTML to be inspected. It is required for most commands. Removing unnecessary content and properties will reduce the number of credits used.","type":"string"},"imageUrl":{"description":"A base64 encoded image.  It is required for specific commands like 'findBlockSelectors'.","type":"string"},"selector":{"description":"A CSS selector indicating the element to inspect in the provided htmlContent. It is required for specific commands like 'findBlockCells'.","type":"string"}},"example":{"command":"findBlockSelectors","prompt":"rectangle with blue background, a heading and paragraph text","imageUrl":"data:image/png;base64,iVBORw0KGgoAAAANS...","htmlContent":"<html>...</html>"}},"ImportAssistantResponse":{"type":"object","properties":{"choices":{"description":"The choices available from the assistant command.","type":"array","items":{"type":"object","properties":{"message":{"description":"The message from the assistant command.","type":"object","properties":{"content":{"description":"The content of the message.","type":"string"}}}}}}},"example":{"choices":[{"message":{"content":"div.main div.product"}}]}},"EmailAddress":{"type":"string","format":"email","example":"user@example.com"}},"examples":{"analytics-site-integration-aa-tags":{"summary":"Example for an integration with Adobe Analytics via Adobe Tags","value":{"siteId":"a31fa5e4-90be-4440-a063-e6d6aa5a127a","reporting":{"link":"https://www5.an.adobe.com/x/5_19xzaq4","timezone":"UTC-07:00"},"dataCollection":{"type":"adobe-tags","environments":{"development":"https://assets.adobedtm.com/51b39232f777/342ccd9ca453/launch-e2732f4a5678-development.min.js","production":"https://assets.adobedtm.com/51b39232f777/342ccd9ca453/launch-e2732f4a5678.min.js"}},"dataStore":{"type":"adobe-analytics","id":"ageo1xxpnwexamplerumanalytics"},"dataMapping":{"type":"adobe-analytics","mappings":{"All Page Views":"event4","Page URL":"evar2","Data Source":"evar3","Site Domain":"evar4"}}}},"analytics-site-integration-aa-aep-websdk":{"summary":"Example for an integration with Adobe Analytics via Adobe Experience Platform and WebSDK","value":{"siteId":"a31fa5e4-90be-4440-a063-e6d6aa5a127a","reporting":{"link":"https://www5.an.adobe.com/x/5_19xzaq4","timezone":"UTC-07:00"},"dataCollection":{"type":"aep-websdk","environments":{"development":"caad777c-c410-4ceb-8b36-167f12435","production":"caad777c-c410-4ceb-43f2-167f12435"}},"dataStore":{"type":"adobe-analytics","id":"ageo1xxpnwexamplerumanalytics"},"dataMapping":{"type":"xdm","mappings":{"All Page Views":"web.webPageDetails.pageViews.value","Page URL":"web.webPageDetails.URL","Data Source":"_example.dataSource","Site Domain":"web.webPageDetails.server"}}}},"analytics-site-integration-cja-tags":{"summary":"Example for an integration with Customer Adobe Analytics via Adobe Experience Platform and Adobe Tags","value":{"siteId":"a31fa5e4-90be-4440-a063-e6d6aa5a127a","reporting":{"link":"https://analytics.adobe.com/?linkId=8296eaea-aa9a-4840-8a86-71df75661&dpc=acc","timezone":"UTC-07:00"},"dataCollection":{"type":"adobe-tags","environments":{"development":"https://assets.adobedtm.com/51b39232f777/342ccd9ca453/launch-e2732f4a5678-development.min.js","production":"https://assets.adobedtm.com/51b39232f777/342ccd9ca453/launch-e2732f4a5678.min.js"}},"dataStore":{"type":"aep","id":"64cd250cdc886828d309a2215"},"dataSchema":{"id":"https://ns.adobe.com/example/schemas/203ff63ed073c85d5fad4274f27d2fc2e9b834b06778f8"},"dataMapping":{"type":"xdm","mappings":{"All Page Views":"web.webPageDetails.pageViews.value","Page URL":"web.webPageDetails.URL","Data Source":"_example.dataSource","Site Domain":"web.webPageDetails.server"}}}},"analytics-site-integration-cja-websdk":{"summary":"Example for an integration with Customer Adobe Analytics via Adobe Experience Platform and WebSDK","value":{"siteId":"a31fa5e4-90be-4440-a063-e6d6aa5a127a","reporting":{"link":"https://analytics.adobe.com/?linkId=8296eaea-aa9a-4840-8a86-71df75661&dpc=acc","timezone":"UTC-07:00"},"dataCollection":{"type":"aep-websdk","environments":{"development":"caad777c-c410-4ceb-8b36-167f12435","production":"caad777c-c410-4ceb-43f2-167f12435"}},"dataStore":{"type":"aep","id":"64cd250cdc886828d309a2215"},"dataSchema":{"id":"https://ns.adobe.com/example/schemas/203ff63ed073c85d5fad4274f27d2fc2e9b834b06778f8"},"dataMapping":{"type":"xdm","mappings":{"All Page Views":"web.webPageDetails.pageViews.value","Page URL":"web.webPageDetails.URL","Data Source":"_example.dataSource","Site Domain":"web.webPageDetails.server"}}}},"generic-audit":{"summary":"Example for a generic audit","value":{"siteId":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","auditedAt":"2024-01-20T12:00:00Z","expiresAt":"2024-07-20T12:00:00Z","auditType":"cwv","isError":false,"deliveryType":"aem_edge","fullAuditRef":"https://some-audit-system/full-report/1234","auditResult":{"someProperty":"someValue"},"previousAuditResult":{"someProperty":"somePreviousValue"}}},"broken-backlinks-audit":{"summary":"Example for a broken-backlinks audit","value":{"siteId":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","auditedAt":"2024-01-20T12:00:00Z","expiresAt":"2024-07-20T12:00:00Z","auditType":"broken-backlinks","deliveryType":"aem_edge","isError":false,"isLive":true,"fullAuditRef":"https://api.ahrefs.com/v3/site-explorer/broken-backlinks?select=title%2Curl_from%2Curl_to%2Ctraffic_domain&limit=50&mode=prefix&order_by=domain_rating_source%3Adesc%2Ctraffic_domain%3Adesc&target=example.com&output=json&where=%7B%22and%22%3A%5B%7B%22field%22%3A%22is_dofollow%22%2C%22is%22%3A%5B%22eq%22%2C1%5D%7D%2C%7B%22field%22%3A%22is_content%22%2C%22is%22%3A%5B%22eq%22%2C1%5D%7D%2C%7B%22field%22%3A%22domain_rating_source%22%2C%22is%22%3A%5B%22gte%22%2C29.5%5D%7D%2C%7B%22field%22%3A%22traffic_domain%22%2C%22is%22%3A%5B%22gte%22%2C500%5D%7D%2C%7B%22field%22%3A%22links_external%22%2C%22is%22%3A%5B%22lte%22%2C300%5D%7D%5D%7D","auditResult":{"brokenBacklinks":{"urls_suggested":["https://www.example.com/article/cats/pet-care/selecting-the-right-toys-for-your-cats-play-preference"],"url_to":"https://www.example.com/article/cats/pet-care/safe-and-sound-toys-for-your-cat/","title":"Choosing the Best Cat Toys: A Comprehensive Guide - Petful","url_from":"https://www.petful.com/pet-products/choosing-the-best-cat-toys/","traffic_domain":65272}}}},"costs-audit":{"summary":"Example for a costs audit","value":{"ahrefs":{"usedApiUnits":198771,"limitApiUnits":1000000,"fullAuditRef":"https://api.ahrefs.com/v3/subscription-info/limits-and-usage"}}},"meta-tags-audit":{"summary":"Example for a meta-tags audit","value":{"auditResult":{"sourceS3Folder":"spacecat-scraper-dev/scrapes/cccdac43-1a22-4659-9086-b762f59b9928/","detectedTags":{"/de":{"title":{"seoRecommendation":"Should be present","issue":"Missing Title","issueDetails":"Title tag is missing","seoImpact":"High"}}},"finalUrl":"www.bulk.com/uk/"},"auditType":"meta-tags","auditedAt":"2025-01-03T10:14:41.798Z","fullAuditRef":null,"isLive":true,"isError":false,"siteId":"cccdac43-1a22-4659-9086-b762f59b9928"}},"broken-internal-links-audit":{"summary":"Example for a broken-internal-links audit","value":{"siteId":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","auditedAt":"2024-01-20T12:00:00Z","expiresAt":"2024-07-20T12:00:00Z","auditType":"broken-internal-links","deliveryType":"aem_edge","isError":false,"isLive":true,"fullAuditRef":"https://petplace.com","auditResult":{"brokenInternalLinks":{"urlsSuggested":["https://www.example.com/article/cats/pet-care/selecting-the-right-toys-for-your-cats-play-preference"],"urlTo":"https://www.example.com/article/cats/pet-care/safe-and-sound-toys-for-your-cat/","title":"Choosing the Best Cat Toys: A Comprehensive Guide","urlFrom":"https://www.example.com/article/cats/pet-care/toys-for-your-cat/","aiRationale":"The URL is about toys for your cat, so it should be redirected to the toys for your cat page.","priority":"high","trafficDomain":65272},"finalUrl":"www.example.com/uk/"}}},"broken-backlinks-opportunity-create":{"description":"Example for a broken backlinks opportunity create","value":{"auditId":"123e4567-e89b-12d3-a456-426614174000","runbook":"https://example.com/runbook/broken-backlinks","type":"broken-backlinks","origin":"AUTOMATION","title":"Authoritative domains are linking to invalid SecurBank URLs. This could impact your SEO.","description":"Provide the correct target URL that each of the broken backlinks should be redirected to.","guidance":{"steps":["Review the list of broken target URLs and the suggested redirects.","Manually override redirect URLs as needed.","Copy redirects.","Paste new entries in your website redirects file.","Publish the changes."]},"tags":["Traffic acquisition"]}},"broken-backlinks-opportunity":{"description":"Example for a broken backlinks opportunity","value":{"id":"123e4567-e89b-12d3-a456-426614174000","siteId":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","auditId":"123e4567-e89b-12d3-a456-426614174000","runbook":"https://example.com/runbook/broken-backlinks","type":"broken-backlinks","origin":"AUTOMATION","title":"Authoritative domains are linking to invalid SecurBank URLs. This could impact your SEO.","description":"Provide the correct target URL that each of the broken backlinks should be redirected to.","status":"IN_PROGRESS","guidance":{"steps":["Review the list of broken target URLs and the suggested redirects.","Manually override redirect URLs as needed.","Copy redirects.","Paste new entries in your website redirects file.","Publish the changes."]},"tags":["Traffic acquisition"],"createdAt":"2024-01-20T12:00:00Z","updatedAt":"2024-07-23T12:00:00Z"}},"broken-backlinks-opportunity-update":{"description":"Example for a broken backlinks opportunity update","value":{"runbook":"https://example.com/runbook/broken-backlinks-v2","title":"10 authoritative domains are linking to invalid SecurBank URLs. This could impact your SEO."}},"broken-backlinks-suggestion-create-list":{"description":"Example for a broken backlinks suggestion create list","value":[{"type":"REDIRECT_UPDATE","rank":571000,"data":null,"title":"Black Friday Sale at Example Inc.","url_from":"https://www.dailynews.com/2024/08/13/black-friday-sale-at-example-inc/","url_to":"https://www.example.com/CustomerServiceView.aspx","urls_suggested":["https://www.example.com/customer-service/contact","https://www.example.com/customer-service"],"ai_rationale":"The URL is about customer service, so it should be redirected to the customer service page.","traffic_domain":571000},{"type":"REDIRECT_UPDATE","rank":123000,"data":{"title":"Black Friday Sale at Example Inc.","url_from":"https://www.dailynews.com/2024/08/13/black-friday-sale-at-example-inc/","url_to":"https://www.example.com/get-a-promo-code.aspx","urls_suggested":["https://www.example.com/offers/promo-codes"],"traffic_domain":123000}}]},"broken-backlinks-suggestion-create-list-response":{"description":"Example for a broken backlinks suggestion create list response","value":{"suggestions":[{"index":0,"statusCode":201,"suggestion":{"id":"2563e4567-f543-12d3-a456-426614174000","opportunityId":"123e4567-e89b-12d3-a456-426614174000","type":"REDIRECT_UPDATE","status":"NEW","rank":571000,"data":{"title":"Black Friday Sale at Example Inc.","url_from":"https://www.dailynews.com/2024/08/13/black-friday-sale-at-example-inc/","url_to":"https://www.example.com/CustomerServiceView.aspx","urls_suggested":["https://www.example.com/customer-service/contact","https://www.example.com/customer-service"],"traffic_domain":571000},"createdAt":"2024-01-22T12:00:00Z","updatedAt":"2024-07-26T12:00:00Z"}},{"index":1,"statusCode":400,"message":"Validation failed in suggestion: type is required"}],"metadata":{"total":2,"success":1,"failure":1}}},"broken-backlinks-suggestion":{"description":"Example for a broken backlinks suggestion","value":{"id":"213e4567-f543-12d3-a456-426614174000","opportunityId":"123e4567-e89b-12d3-a456-426614174000","type":"REDIRECT_UPDATE","rank":571000,"data":{"title":"Black Friday Sale at Example Inc.","url_from":"https://www.dailynews.com/2024/08/13/black-friday-sale-at-example-inc/","url_to":"https://www.example.com/CustomerServiceView.aspx","urls_suggested":["https://www.example.com/customer-service/contact","https://www.example.com/customer-service"],"ai_rationale":"The URL is about customer service, so it should be redirected to the customer service page.","traffic_domain":571000},"status":"APPROVED","createdAt":"2024-01-22T12:00:00Z","updatedAt":"2024-07-26T12:00:00Z"}},"broken-backlinks-suggestion-update":{"description":"Example for a broken backlinks suggestion","value":{"rank":571000,"data":{"proposedTargetURLs":["https://www.example.com/customer-service/contact"],"manualOverrideURL":"https://www.example.com/customer-service/faq"}}},"broken-backlinks-suggestions-status-update":{"description":"Example for broken backlinks suggestions status update","value":[{"id":"213e4567-f543-12d3-a456-426614174000","status":"APPROVED"},{"id":"945e4567-f543-12d3-a456-426614174010","status":"SKIPPED"}]},"broken-backlinks-suggestions-status-update-response":{"description":"Example for broken backlinks suggestions status update response","value":{"suggestions":[{"index":0,"statusCode":200,"suggestion":{"id":"213e4567-f543-12d3-a456-426614174000","opportunityId":"123e4567-e89b-12d3-a456-426614174000","type":"REDIRECT_UPDATE","rank":571000,"data":{"title":"Black Friday Sale at Example Inc.","url_from":"https://www.dailynews.com/2024/08/13/black-friday-sale-at-example-inc/","url_to":"https://www.example.com/CustomerServiceView.aspx","urls_suggested":["https://www.example.com/customer-service/contact","https://www.example.com/customer-service"],"traffic_domain":571000},"status":"APPROVED","createdAt":"2024-01-22T12:00:00Z","updatedAt":"2024-07-26T12:00:00Z"}},{"id":"945e4567-f543-12d3-a456-426614174010","index":1,"statusCode":400,"message":"Validation failed in suggestion: status must be one of NEW,APPROVED,SKIPPED,FIXED,ERROR"}],"metadata":{"total":2,"success":1,"failure":1}}}},"parameters":{"auditType":{"name":"auditType","description":"The type of the audit","in":"path","required":true,"schema":{"$ref":"#/components/schemas/AuditType"}},"ascending":{"name":"ascending","description":"Whether to sort ascending or descending","in":"query","required":false,"schema":{"type":"boolean","default":false}},"siteId":{"name":"siteId","description":"The site ID in uuid format","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Id"}},"hookSecret":{"name":"hookSecret","description":"Secret for the incoming webhook","in":"path","required":true,"schema":{"type":"string"}},"organizationId":{"name":"organizationId","description":"The organization ID in uuid format","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Id"}},"imsOrgId":{"name":"imsOrgId","description":"An IMS organization ID","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ImsOrganizationId"}},"deliveryType":{"name":"deliveryType","description":"The type of the delivery this site is using","in":"path","required":true,"schema":{"$ref":"#/components/schemas/DeliveryType"}},"base64BaseUrl":{"name":"base64BaseUrl","description":"Base64-encoded base URL","in":"path","required":true,"schema":{"type":"string","format":"base64url"}},"auditedAt":{"name":"auditedAt","description":"The date and time of the audit in ISO 8601 format","in":"path","required":true,"schema":{"$ref":"#/components/schemas/DateTime"}},"opportunityId":{"name":"opportunityId","description":"The opportunity ID in uuid format","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Id"}},"suggestionId":{"name":"suggestionId","description":"The suggestion ID in uuid format","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Id"}},"keyEventId":{"name":"keyEventId","description":"The key event ID in uuid format","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Id"}},"source":{"name":"source","description":"The source of the top pages","in":"path","required":true,"schema":{"type":"string","enum":["ahrefs"],"example":"ahrefs"}},"geo":{"name":"geo","description":"The geo of the top pages","in":"path","required":true,"schema":{"type":"string","example":"au"}},"metric":{"name":"metric","description":"The name of the site metric","in":"path","required":true,"schema":{"type":"string","enum":["organic-traffic"],"example":"organic-traffic"}},"base64PageUrl":{"name":"base64PageUrl","description":"Base64-encoded page URL","in":"path","required":true,"schema":{"type":"string","format":"base64url"}},"triggerUrl":{"name":"url","description":"The URL or Site ID to trigger the audit for","in":"query","required":true,"schema":{"type":"string"}},"triggerType":{"name":"type","description":"The type of the audit to trigger","in":"query","required":true,"schema":{"$ref":"#/components/schemas/AuditType"}},"apiKeyId":{"name":"apiKeyId","description":"The API key ID in uuid format","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Id"}},"jobId":{"name":"jobId","description":"The job ID in uuid format","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Id"}}},"headers":{"xError":{"description":"A short descriptive error message","schema":{"format":"none","type":"string"}}},"responses":{"400":{"description":"Invalid request.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated."},"404":{"description":"Not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Too many requests.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Internal server error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Service Unavailable.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-no-audit-type":{"description":"Bad request. Audit Type is required.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"404-configuration-not-found-with-version":{"description":"Configuration not found with this version.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-bad-hoolihan-event":{"description":"Bad request. Did not match expected Hoolihan message format.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-no-site-id":{"description":"Bad request. Site ID is required.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"404-site-not-found-with-id":{"description":"Site not found with given ID.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-empty-request-body-validation-failure":{"description":"Bad request. No or empty request body or required Organization properties missing.\n","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-no-organization-id":{"description":"Bad request. Organization ID is required.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"404-organization-not-found-with-id":{"description":"Organization not found with given ID.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-no-organization-id-request-body-no-updates":{"description":"Bad request. No or empty Organization ID is provided, or request body is empty, or no updates have been provided.\n","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-bad-ims-org-id":{"description":"Bad request. IMS org ID param was not in the expected format.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-max-scrape-urls-exceeded":{"description":"Bad request. The maximum number of URLs that can be scraped in a single request is 10.\n","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-no-delivery-type":{"description":"Bad request. Delivery Type is required.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-no-base-url":{"description":"Bad request. Base URL is required.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"404-site-not-found-with-base-url":{"description":"Site not found with given Base URL.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-no-site-id-request-body-no-updates":{"description":"Bad request. No or empty Site ID is provided, or request body is empty, or no updates have been provided.\n","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-audit-for-site":{"description":"Bad request. Site ID, Audit Type and Audited At are required.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"404-audit-not-found":{"description":"Audit not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-latest-audit-for-site":{"description":"Bad request. Site ID and Audit Type are required.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-patch-audit-for-site":{"description":"No updates provided.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-no-key-event-id":{"description":"Bad request. Key Event ID is required.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"404-key-event-not-found-with-id":{"description":"Key event not found with given ID.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-missing-params-or-unknown-audit-type":{"description":"Bad request. URL parameters _url_ or _type_ are missing, or audit type is unknown.\n","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"403-max-api-keys-exceeded":{"description":"Forbidden. The maximum number of API keys that can be created per client has been exceeded.\n","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}}}},"searchIndex":{"store":["section/Authentication","tag/site","tag/site/operation/getSitesForOrganization","tag/site/operation/createSite","tag/site/operation/getSites","tag/site/operation/getSitesByDeliveryType","tag/site/operation/getSiteByBaseUrl","tag/site/operation/getSitesWithLatestAudit","tag/site/paths/~1sites~1{siteId}~1latest-metrics/get","tag/site/operation/getSite","tag/site/operation/patchSite","tag/site/operation/deleteSite","tag/site/operation/patchAuditForSite","tag/site/operation/getKeyEvents","tag/site/operation/createKeyEvent","tag/site/operation/deleteKeyEvent","tag/site/operation/getSiteTopPages","tag/site/operation/getSiteTopPagesBySource","tag/site/operation/getSiteTopPagesBySourceAndGeo","tag/site/operation/getSiteMetricsBySource","tag/site/operation/getPageMetricsBySource","tag/site/operation/getExperiments","tag/audit","tag/audit/operation/getAllAudits","tag/audit/operation/getAllAuditsForSite","tag/audit/operation/getAllAuditsOfTypeForSite","tag/audit/operation/getAuditForSite","tag/audit/operation/getAllAuditsForSite","tag/audit/operation/getLatestAuditForSite","tag/audit/operation/patchAuditForSite","tag/auth","tag/auth/operation/googleAuth","tag/organization","tag/organization/operation/createOrganization","tag/organization/operation/getOrganizations","tag/organization/operation/getOrganization","tag/organization/operation/patchOrganization","tag/organization/operation/deleteOrganization","tag/organization/operation/getSitesForOrganization","tag/organization/operation/getOrganizationByImsOrgId","tag/organization/operation/getSlackConfigByImsOrgId","tag/trigger","tag/trigger/operation/triggerAudit","tag/hooks","tag/hooks/operation/processFulfillmentEvents","tag/hooks/operation/siteDetectionCdn","tag/hooks/operation/siteDetectionRum","tag/hooks/operation/processAnalyticsSiteIntegration","tag/slack","tag/slack/operation/inviteToSlackChannelByUserId","tag/api-keys","tag/api-keys/operation/createApiKey","tag/api-keys/operation/getApiKeys","tag/api-keys/operation/deleteApiKey","tag/import","tag/import/operation/startImportJob","tag/import/operation/getImportJobStatus","tag/import/operation/deleteImportJob","tag/import/operation/stopImportJob","tag/import/operation/getImportJobProgress","tag/import/operation/getImportJobArchive","tag/import/operation/processImportAssistant","tag/scrape","tag/scrape/operation/scrape","tag/configuration","tag/configuration/operation/getAllConfigurations","tag/configuration/operation/getLatestConfiguration","tag/configuration/operation/getConfigurationByVersion","tag/configuration/operation/update","tag/metrics","tag/metrics/paths/~1sites~1{siteId}~1latest-metrics/get","tag/metrics/operation/getSiteMetricsBySource","tag/metrics/operation/getPageMetricsBySource","tag/opportunities","tag/opportunities/paths/~1sites~1{siteId}~1opportunities/get","tag/opportunities/paths/~1sites~1{siteId}~1opportunities/post","tag/opportunities/paths/~1sites~1{siteId}~1opportunities~1by-status~1{status}/get","tag/opportunities/paths/~1sites~1{siteId}~1opportunities~1{opportunityId}/get","tag/opportunities/paths/~1sites~1{siteId}~1opportunities~1{opportunityId}/patch","tag/opportunities/paths/~1sites~1{siteId}~1opportunities~1{opportunityId}/delete","tag/opportunity-suggestions","tag/opportunity-suggestions/paths/~1sites~1{siteId}~1opportunities~1{opportunityId}~1suggestions/get","tag/opportunity-suggestions/paths/~1sites~1{siteId}~1opportunities~1{opportunityId}~1suggestions/post","tag/opportunity-suggestions/paths/~1sites~1{siteId}~1opportunities~1{opportunityId}~1suggestions~1by-status~1{status}/get","tag/opportunity-suggestions/paths/~1sites~1{siteId}~1opportunities~1{opportunityId}~1suggestions~1{suggestionId}/get","tag/opportunity-suggestions/paths/~1sites~1{siteId}~1opportunities~1{opportunityId}~1suggestions~1{suggestionId}/patch","tag/opportunity-suggestions/paths/~1sites~1{siteId}~1opportunities~1{opportunityId}~1suggestions~1{suggestionId}/delete","tag/opportunity-suggestions/paths/~1sites~1{siteId}~1opportunities~1{opportunityId}~1suggestions~1status/patch","tag/key-event","tag/key-event/operation/getKeyEvents","tag/key-event/operation/createKeyEvent","tag/key-event/operation/deleteKeyEvent","tag/top-pages","tag/top-pages/operation/getSiteTopPages","tag/top-pages/operation/getSiteTopPagesBySource","tag/top-pages/operation/getSiteTopPagesBySourceAndGeo","tag/experiments","tag/experiments/operation/getExperiments"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,3.866]],["description/0",[1,6.256,2,4.99]],["title/1",[3,0.404]],["description/1",[3,0.425,4,4.066]],["title/2",[3,0.305,5,0.427,6,1.499]],["description/2",[3,0.344,5,0.481,6,1.688,7,0.575,8,0.814,9,4.446]],["title/3",[3,0.305,10,1.923,11,2.062]],["description/3",[3,0.444,7,0.575,8,0.814,10,2.165,11,2.322]],["title/4",[3,0.348,5,0.486]],["description/4",[3,0.458,5,0.505,7,0.604,8,0.854]],["title/5",[3,0.272,5,0.381,12,2.957,13,2.147]],["description/5",[3,0.328,5,0.459,7,0.549,8,0.777,12,3.566,13,2.588,14,4.833]],["title/6",[3,0.245,5,0.343,15,2.227,16,2.884,17,1.719]],["description/6",[3,0.333,5,0.24,7,0.288,8,0.638,16,3.91,17,2.64,18,2.531,19,2.222,20,1.301,21,1.559,22,3.972,23,2.531,24,2.531,25,2.019,26,2.531,27,2.531,28,2.222,29,2.531]],["title/7",[3,0.245,5,0.343,30,2.023,31,1.936,32,1.205]],["description/7",[3,0.317,5,0.297,7,0.355,8,0.502,30,2.612,31,2.501,32,2.066,33,2.494,34,2.746,35,2.746,36,2.494,37,2.746,38,3.127]],["title/8",[3,0.305,31,2.408,39,2.139]],["description/8",[3,0.185,5,0.259,6,0.909,30,1.525,31,1.46,39,2.001,40,1.296,41,2.735,42,2.394,43,1.881,44,2.394,45,3.104,46,1.597,47,1.525,48,2.394,49,2.175,50,2.175,51,2.011,52,0.909,53,1.401,54,2.394]],["title/9",[3,0.272,5,0.381,15,2.469,20,2.06]],["description/9",[3,0.344,5,0.481,7,0.575,8,0.814,20,2.602,55,4.039]],["title/10",[3,0.348,56,2.632]],["description/10",[3,0.225,7,0.378,8,0.534,21,2.046,55,2.65,56,2.976,57,4.289,58,2.65,59,3.008,60,4.289,61,2.917,62,2.292]],["title/11",[3,0.348,63,2.348]],["description/11",[3,0.361,7,0.604,8,0.854,55,4.242,63,2.438]],["title/12",[32,1.499,53,2.311,56,2.311]],["description/12",[7,0.465,8,0.657,17,1.945,32,1.888,53,2.101,56,2.101,64,3.591,65,2.658,66,3.591,67,3.591]],["title/13",[3,0.272,5,0.381,52,1.336,68,1.605]],["description/13",[3,0.278,7,0.465,47,2.288,52,1.363,68,1.637,69,3.591,70,3.017,71,4.974,72,2.396,73,3.017]],["title/14",[3,0.245,10,1.546,11,1.658,52,1.205,68,1.448]],["description/14",[3,0.328,7,0.549,10,2.067,11,2.216,52,1.611,68,1.935,73,3.566]],["title/15",[52,1.499,63,2.062,68,1.8]],["description/15",[7,0.604,52,1.772,63,2.438,68,2.129,74,4.668]],["title/16",[3,0.272,5,0.381,75,1.906,76,1.605]],["description/16",[3,0.212,5,0.297,7,0.355,8,0.502,46,1.832,72,1.832,75,2.221,76,1.869,77,1.832,78,2.399,79,3.445,80,1.434,81,2.032,82,2.307,83,2.746]],["title/17",[3,0.245,5,0.343,75,1.719,76,1.448,80,1.658]],["description/17",[3,0.219,5,0.306,7,0.366,8,0.518,46,1.888,72,1.888,75,2.271,76,1.911,77,1.888,78,2.453,79,3.522,81,2.094,82,2.377,84,2.829]],["title/18",[3,0.223,5,0.313,75,1.566,76,1.318,80,1.51,81,2.14]],["description/18",[3,0.249,5,0.348,7,0.417,8,0.589,46,2.148,72,2.148,75,2.495,76,2.1,77,2.148,78,2.695,85,3.219]],["title/19",[3,0.272,5,0.381,39,1.906,80,1.838]],["description/19",[3,0.328,5,0.459,7,0.549,8,0.777,39,2.298,80,2.216,86,4.244]],["title/20",[5,0.381,39,1.906,76,1.605,80,1.838]],["description/20",[5,0.459,7,0.549,8,0.777,39,2.298,76,1.935,80,2.216,87,4.244]],["title/21",[3,0.305,5,0.427,88,3.103]],["description/21",[3,0.258,7,0.431,21,2.338,41,2.468,45,2.801,88,3.711,89,2.468,90,3.334,91,1.806,92,3.334,93,2.801,94,3.334]],["title/22",[32,1.982]],["description/22",[4,4.066,32,2.085]],["title/23",[5,0.343,13,1.936,31,1.936,32,1.205,91,1.719]],["description/23",[5,0.348,7,0.417,8,0.589,13,1.963,32,1.748,78,1.884,91,1.743,95,2.529,96,2.148,97,2.705,98,2.705,99,2.705,100,3.666]],["title/24",[3,0.305,5,0.427,32,1.499]],["description/24",[3,0.258,5,0.361,7,0.431,8,0.61,32,1.793,78,1.951,95,2.62,96,2.225,97,2.801,98,2.801,99,2.801,101,3.797]],["title/25",[3,0.245,5,0.343,13,1.936,32,1.205,91,1.719]],["description/25",[3,0.24,5,0.337,7,0.403,8,0.569,13,1.898,32,1.706,78,1.821,91,1.685,95,2.445,96,2.077,97,2.615,98,2.615,99,2.615,102,3.544]],["title/26",[3,0.272,5,0.381,15,2.469,32,1.336]],["description/26",[3,0.249,5,0.348,7,0.417,8,0.589,13,1.963,15,2.258,19,3.219,32,2.229,34,3.219,35,3.219,103,3.666]],["title/27",[3,0.305,5,0.427,32,1.499]],["description/27",[3,0.258,5,0.361,7,0.431,8,0.61,32,1.793,78,1.951,95,2.62,96,2.225,97,2.801,98,2.801,99,2.801,104,3.797]],["title/28",[3,0.272,5,0.381,31,2.147,32,1.336]],["description/28",[3,0.324,5,0.306,7,0.366,8,0.518,13,1.725,30,1.802,31,2.557,32,2.097,33,2.57,36,2.57,37,2.829,91,1.532,105,3.222]],["title/29",[32,1.499,53,2.311,56,2.311]],["description/29",[7,0.465,8,0.657,17,1.945,32,1.888,53,2.101,56,2.101,64,3.591,65,2.658,66,3.591,67,3.591]],["title/30",[106,5.947]],["description/30",[0,3.291,107,5.063,108,5.063,109,5.063,110,5.063,111,3.736]],["title/31",[0,3.329,112,4.497]],["description/31",[0,3.783,7,0.483,8,0.683,43,2.934,112,5.111,113,4.253,114,4.253,115,4.253]],["title/32",[6,1.982]],["description/32",[4,4.066,6,2.085]],["title/33",[6,1.499,10,1.923,11,2.062]],["description/33",[6,2.179,7,0.575,8,0.814,10,2.165,11,2.322]],["title/34",[5,0.486,6,1.707]],["description/34",[5,0.505,6,2.248,7,0.604,8,0.854]],["title/35",[5,0.381,6,1.336,15,2.469,20,2.06]],["description/35",[5,0.481,6,1.688,7,0.575,8,0.814,20,2.602,116,4.039]],["title/36",[6,1.707,56,2.632]],["description/36",[6,1.107,7,0.378,8,0.534,21,2.046,56,2.976,57,4.289,58,2.65,59,3.008,60,4.289,61,2.917,62,2.292,116,2.65]],["title/37",[6,1.707,63,2.348]],["description/37",[6,1.772,7,0.604,8,0.854,63,2.438,116,4.242]],["title/38",[3,0.305,5,0.427,6,1.499]],["description/38",[3,0.344,5,0.481,6,1.688,7,0.575,8,0.814,9,4.446]],["title/39",[5,0.343,6,1.205,20,1.858,117,2.227,118,2.494]],["description/39",[5,0.439,6,1.541,7,0.525,8,0.743,20,2.375,117,2.847,118,3.189,119,4.623]],["title/40",[5,0.287,6,1.008,20,1.553,117,1.862,118,2.086,120,1.691,121,2.654]],["description/40",[5,0.404,6,1.418,7,0.483,8,0.683,20,2.185,117,2.619,118,2.934,120,2.379,121,3.734,122,4.253]],["title/41",[123,4.388]],["description/41",[4,4.066,123,4.615]],["title/42",[32,1.707,123,3.779]],["description/42",[2,4.017,3,0.105,7,0.175,8,0.557,13,1.855,16,1.229,17,1.255,20,0.792,28,1.353,32,1.539,33,1.229,47,0.862,62,1.063,120,0.862,123,2.555,124,1.353,125,0.733,126,1.541,127,1.353,128,1.541,129,1.353,130,1.353,131,1.541,132,1.541,133,1.541,134,1.541,135,1.541,136,1.353,137,1.137,138,1.353,139,1.541,140,1.541,141,1.541,142,1.541,143,1.541,144,1.541,145,1.541,146,1.541]],["title/43",[147,4.103]],["description/43",[68,2.365,148,4.713,149,4.713]],["title/44",[68,1.8,150,2.516,151,3.949]],["description/44",[7,0.281,8,0.626,12,1.824,36,1.972,68,1.561,111,1.824,150,1.383,151,2.171,152,2.472,153,2.472,154,4.827,155,2.472,156,2.472,157,2.472,158,2.472,159,2.472,160,2.472,161,2.472,162,2.472,163,2.472,164,2.171,165,2.472,166,2.472,167,2.472]],["title/45",[3,0.205,147,2.086,150,1.691,168,2.23,169,2.654,170,2.654,171,2.23]],["description/45",[7,0.263,30,1.293,49,1.844,51,1.705,120,1.293,147,1.594,148,1.844,149,1.844,150,1.293,168,1.705,170,2.029,171,1.705,172,2.311,173,1.844,174,2.029,175,2.029,176,2.029,177,2.948,178,3.245,179,2.029,180,1.844,181,2.029,182,1.705,183,2.029,184,1.705,185,2.029,186,2.029,187,2.029,188,2.311]],["title/46",[3,0.205,41,1.965,147,2.086,150,1.691,168,2.23,169,2.654,171,2.23]],["description/46",[7,0.263,17,1.099,30,1.293,41,1.502,51,2.726,120,1.293,147,1.594,148,1.844,149,1.844,150,1.293,168,1.705,171,1.705,174,2.029,175,2.029,176,2.029,177,2.948,178,3.245,179,2.029,180,1.844,181,2.029,182,1.705,183,2.029,184,1.705,185,2.029,186,2.029,187,2.029,189,2.311,190,2.311]],["title/47",[3,0.205,68,1.21,150,1.691,182,2.23,191,2.654,192,2.654,193,2.654]],["description/47",[3,0.278,68,1.637,77,2.396,150,2.288,182,3.017,191,3.591,192,3.591,193,3.591,194,3.591,195,4.089,196,4.089]],["title/48",[120,3.327]],["description/48",[120,3.305,197,4.713,198,5.188]],["title/49",[6,1.098,59,2.028,120,1.842,197,2.627,199,2.891,200,2.429]],["description/49",[6,0.805,7,0.275,8,0.388,20,1.967,21,1.488,43,3.281,91,1.149,117,2.929,118,1.667,120,2.142,125,1.149,194,2.121,197,3.054,199,2.121,200,1.782,201,2.416,202,2.416,203,2.416,204,2.416,205,2.416,206,2.121,207,2.416]],["title/50",[208,5.947]],["description/50",[52,1.969,125,2.81,198,5.188]],["title/51",[10,1.714,11,1.838,52,1.336,125,1.906]],["description/51",[0,1.728,7,0.302,8,0.663,10,1.137,11,1.219,30,1.487,47,1.487,52,1.685,65,1.728,125,2.711,137,1.961,173,2.12,180,2.12,206,2.334,209,4.44,210,2.658,211,2.334]],["title/52",[52,1.098,91,1.566,117,2.028,125,1.566,212,3.293,213,2.429]],["description/52",[7,0.525,8,0.743,10,1.977,52,1.541,89,3.005,125,2.198,211,4.059,213,3.411]],["title/53",[52,1.499,63,2.062,125,2.139]],["description/53",[0,2.032,7,0.355,8,0.502,10,1.337,52,1.863,63,2.562,117,1.926,125,2.221,130,2.746,177,2.494,213,2.307,214,2.746,215,3.127,216,3.127]],["title/54",[217,2.543]],["description/54",[12,3.736,111,3.736,125,2.408,164,4.446,217,2.165,218,5.063]],["title/55",[10,1.714,11,1.838,217,1.714,219,1.98]],["description/55",[7,0.316,8,0.263,11,0.75,15,1.007,17,0.778,47,1.554,50,1.305,52,0.545,58,1.305,59,1.711,65,1.063,70,1.207,95,1.916,111,1.207,125,0.778,136,1.436,137,2.049,150,0.915,173,1.305,213,1.207,217,2.045,219,2.109,220,1.635,221,1.635,222,1.436,223,1.635,224,1.007,225,1.128,226,1.207,227,1.635,228,1.635,229,1.635,230,1.635,231,1.635,232,1.635,233,1.635,234,1.635,235,1.635]],["title/56",[217,1.714,219,1.98,224,2.469,225,2.765]],["description/56",[7,0.503,8,0.712,91,2.107,217,1.895,219,2.188,224,2.728,225,3.056,226,3.269,236,3.269]],["title/57",[63,2.062,217,1.923,219,2.221]],["description/57",[4,1.502,7,0.263,8,0.594,10,0.988,17,1.099,21,1.423,52,1.232,63,2.117,91,1.099,125,1.099,127,2.029,209,2.029,217,2.256,219,2.606,226,1.705,236,1.705,237,2.311,238,2.311,239,2.311,240,2.311,241,2.311]],["title/58",[217,1.923,219,2.221,242,4.497]],["description/58",[4,1.607,7,0.281,8,0.397,11,1.134,17,1.176,25,1.972,43,1.706,70,1.824,91,1.176,96,1.449,138,2.171,214,2.171,217,2.064,219,2.384,224,1.523,226,1.824,236,1.824,243,3.899,244,2.472,245,2.472,246,1.706,247,2.472,248,2.472]],["title/59",[217,1.714,219,1.98,225,2.765,249,3.52]],["description/59",[7,0.503,8,0.712,91,2.107,217,1.895,219,2.188,225,3.056,236,3.269,249,3.89,250,4.43]],["title/60",[17,1.235,59,1.6,96,1.522,217,1.111,219,1.283,251,2.597,252,2.281,253,2.597,254,2.281]],["description/60",[7,0.345,8,0.488,30,2.556,96,1.78,217,2.349,219,2.257,222,2.667,252,2.667,254,2.667,255,3.037,256,3.037,257,3.037,258,3.037,259,3.037,260,3.037,261,3.037]],["title/61",[184,2.957,217,1.714,262,3.52,263,3.52]],["description/61",[7,0.345,8,0.734,17,1.444,47,1.699,59,1.871,77,1.78,137,2.241,184,2.241,217,1.299,262,4.012,263,2.667,264,3.037,265,3.037,266,3.037,267,3.037,268,3.037,269,3.037,270,3.037]],["title/62",[246,4.103]],["description/62",[76,2.241,125,2.662,246,3.861,271,5.597]],["title/63",[17,2.139,65,2.923,246,3.103]],["description/63",[7,0.478,15,1.679,17,2.444,25,2.175,47,1.525,59,1.679,65,1.772,78,1.401,96,1.597,124,2.394,246,3.986,272,2.726,273,2.726,274,2.726,275,2.726,276,2.726,277,2.726,278,2.726]],["title/64",[53,3.056]],["description/64",[]],["title/65",[53,2.632,279,4.086]],["description/65",[53,3.415]],["title/66",[31,2.408,53,2.311,279,3.588]],["description/66",[280,6.647]],["title/67",[40,1.906,53,2.06,129,3.52,279,3.198]],["description/67",[281,6.647]],["title/68",[3,0.272,32,1.336,282,3.52,283,3.52]],["description/68",[3,0.301,7,0.503,8,0.712,13,2.373,32,1.477,40,2.107,282,3.89,283,3.89,284,4.43]],["title/69",[39,2.828]],["description/69",[]],["title/70",[3,0.305,31,2.408,39,2.139]],["description/70",[3,0.185,5,0.259,6,0.909,30,1.525,31,1.46,39,2.001,40,1.296,41,2.735,42,2.394,43,1.881,44,2.394,45,3.104,46,1.597,47,1.525,48,2.394,49,2.175,50,2.175,51,2.011,52,0.909,53,1.401,54,2.394]],["title/71",[3,0.272,5,0.381,39,1.906,80,1.838]],["description/71",[3,0.328,5,0.459,7,0.549,8,0.777,39,2.298,80,2.216,86,4.244]],["title/72",[5,0.381,39,1.906,76,1.605,80,1.838]],["description/72",[5,0.459,7,0.549,8,0.777,39,2.298,76,1.935,80,2.216,87,4.244]],["title/73",[285,3.185]],["description/73",[]],["title/74",[3,0.245,5,0.343,40,1.719,89,2.35,285,1.936]],["description/74",[286,5.836]],["title/75",[3,0.245,10,1.546,11,1.658,40,1.719,285,1.936]],["description/75",[286,5.836]],["title/76",[3,0.223,5,0.313,40,1.566,224,2.028,285,1.763,287,2.891]],["description/76",[288,6.647]],["title/77",[5,0.381,40,1.906,93,2.957,285,2.147]],["description/77",[289,5.303]],["title/78",[40,1.719,56,1.858,200,2.668,285,1.936,290,3.175]],["description/78",[289,5.303]],["title/79",[2,2.627,63,1.51,285,1.763,291,3.293,292,1.93,293,3.293]],["description/79",[289,5.303]],["title/80",[294,5.947]],["description/80",[]],["title/81",[5,0.343,40,1.719,89,2.35,285,1.936,292,2.119]],["description/81",[295,5.836]],["title/82",[10,1.111,62,2.796,89,1.688,285,1.391,292,1.522,296,2.597,297,2.597,298,2.281]],["description/82",[295,5.836]],["title/83",[5,0.313,40,1.566,224,2.028,285,1.763,287,2.891,292,1.93]],["description/83",[299,6.647]],["title/84",[5,0.381,40,1.906,93,2.957,292,2.349]],["description/84",[300,5.303]],["title/85",[40,1.719,56,1.858,200,2.668,290,3.175,292,2.119]],["description/85",[300,5.303]],["title/86",[63,2.348,292,3.001]],["description/86",[300,5.303]],["title/87",[56,1.553,62,3.141,224,1.862,292,1.771,298,2.654,301,3.023]],["description/87",[302,6.647]],["title/88",[52,1.707,68,2.05]],["description/88",[]],["title/89",[3,0.272,5,0.381,52,1.336,68,1.605]],["description/89",[3,0.278,7,0.465,47,2.288,52,1.363,68,1.637,69,3.591,70,3.017,71,4.974,72,2.396,73,3.017]],["title/90",[3,0.245,10,1.546,11,1.658,52,1.205,68,1.448]],["description/90",[3,0.328,7,0.549,10,2.067,11,2.216,52,1.611,68,1.935,73,3.566]],["title/91",[52,1.499,63,2.062,68,1.8]],["description/91",[7,0.604,52,1.772,63,2.438,68,2.129,74,4.668]],["title/92",[75,2.436,76,2.05]],["description/92",[]],["title/93",[3,0.272,5,0.381,75,1.906,76,1.605]],["description/93",[3,0.212,5,0.297,7,0.355,8,0.502,46,1.832,72,1.832,75,2.221,76,1.869,77,1.832,78,2.399,79,3.445,80,1.434,81,2.032,82,2.307,83,2.746]],["title/94",[3,0.245,5,0.343,75,1.719,76,1.448,80,1.658]],["description/94",[3,0.219,5,0.306,7,0.366,8,0.518,46,1.888,72,1.888,75,2.271,76,1.911,77,1.888,78,2.453,79,3.522,81,2.094,82,2.377,84,2.829]],["title/95",[3,0.223,5,0.313,75,1.566,76,1.318,80,1.51,81,2.14]],["description/95",[3,0.249,5,0.348,7,0.417,8,0.589,46,2.148,72,2.148,75,2.495,76,2.1,77,2.148,78,2.695,85,3.219]],["title/96",[88,4.103]],["description/96",[]],["title/97",[3,0.305,5,0.427,88,3.103]],["description/97",[3,0.258,7,0.431,21,2.338,41,2.468,45,2.801,88,3.711,89,2.468,90,3.334,91,1.806,92,3.334,93,2.801,94,3.334]]],"invertedIndex":[["",{"_index":2,"title":{"79":{}},"description":{"0":{},"42":{}}}],["10",{"_index":278,"title":{},"description":{"63":{}}}],["3rd",{"_index":109,"title":{},"description":{"30":{}}}],["404",{"_index":140,"title":{},"description":{"42":{}}}],["429",{"_index":233,"title":{},"description":{"55":{}}}],["503",{"_index":229,"title":{},"description":{"55":{}}}],["access",{"_index":203,"title":{},"description":{"49":{}}}],["add",{"_index":296,"title":{"82":{}},"description":{}}],["addit",{"_index":238,"title":{},"description":{"57":{}}}],["against",{"_index":108,"title":{},"description":{"30":{}}}],["ai",{"_index":267,"title":{},"description":{"61":{}}}],["allow",{"_index":25,"title":{},"description":{"6":{},"58":{},"63":{}}}],["along",{"_index":92,"title":{},"description":{"21":{},"97":{}}}],["analyt",{"_index":193,"title":{"47":{}},"description":{"47":{}}}],["analyz",{"_index":268,"title":{},"description":{"61":{}}}],["apex",{"_index":141,"title":{},"description":{"42":{}}}],["api",{"_index":125,"title":{"51":{},"52":{},"53":{}},"description":{"42":{},"49":{},"50":{},"51":{},"52":{},"53":{},"54":{},"55":{},"57":{},"62":{}}}],["api-key",{"_index":208,"title":{"50":{}},"description":{}}],["applic",{"_index":279,"title":{"65":{},"66":{},"67":{}},"description":{}}],["archiv",{"_index":254,"title":{"60":{}},"description":{"60":{}}}],["array",{"_index":36,"title":{},"description":{"7":{},"28":{},"44":{}}}],["ascend",{"_index":98,"title":{},"description":{"23":{},"24":{},"25":{},"27":{}}}],["assist",{"_index":263,"title":{"61":{}},"description":{"61":{}}}],["associ",{"_index":291,"title":{"79":{}},"description":{}}],["asynchron",{"_index":136,"title":{},"description":{"42":{},"55":{}}}],["attribut",{"_index":290,"title":{"78":{},"85":{}},"description":{}}],["audit",{"_index":32,"title":{"7":{},"12":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"42":{},"68":{}},"description":{"7":{},"12":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"42":{},"68":{}}}],["auditedat",{"_index":34,"title":{},"description":{"7":{},"26":{}}}],["audits/latest/{audittyp",{"_index":100,"title":{},"description":{"23":{}}}],["auth",{"_index":106,"title":{"30":{}},"description":{}}],["auth/google/{siteid",{"_index":115,"title":{},"description":{"31":{}}}],["authent",{"_index":0,"title":{"0":{},"31":{}},"description":{"30":{},"31":{},"51":{},"53":{}}}],["avail",{"_index":50,"title":{},"description":{"8":{},"55":{},"70":{}}}],["base",{"_index":16,"title":{"6":{}},"description":{"6":{},"42":{}}}],["base64",{"_index":23,"title":{},"description":{"6":{}}}],["bodi",{"_index":60,"title":{},"description":{"10":{},"36":{}}}],["bucket",{"_index":79,"title":{},"description":{"16":{},"17":{},"93":{},"94":{}}}],["cdn",{"_index":170,"title":{"45":{}},"description":{"45":{}}}],["channel",{"_index":197,"title":{"49":{}},"description":{"48":{},"49":{}}}],["charact",{"_index":27,"title":{},"description":{"6":{}}}],["choic",{"_index":269,"title":{},"description":{"61":{}}}],["chronolog",{"_index":69,"title":{},"description":{"13":{},"89":{}}}],["client",{"_index":213,"title":{"52":{}},"description":{"52":{},"53":{},"55":{}}}],["code",{"_index":166,"title":{},"description":{"44":{}}}],["command",{"_index":133,"title":{},"description":{"42":{}}}],["complet",{"_index":182,"title":{"47":{}},"description":{"45":{},"46":{},"47":{}}}],["config",{"_index":121,"title":{"40":{}},"description":{"40":{}}}],["configur",{"_index":53,"title":{"12":{},"29":{},"64":{},"65":{},"66":{},"67":{}},"description":{"8":{},"12":{},"29":{},"65":{},"70":{}}}],["configurations/latest",{"_index":280,"title":{},"description":{"66":{}}}],["configurations/sites/audit",{"_index":284,"title":{},"description":{"68":{}}}],["configurations/{vers",{"_index":281,"title":{},"description":{"67":{}}}],["contain",{"_index":259,"title":{},"description":{"60":{}}}],["content",{"_index":218,"title":{},"description":{"54":{}}}],["contract",{"_index":162,"title":{},"description":{"44":{}}}],["creat",{"_index":10,"title":{"3":{},"14":{},"33":{},"51":{},"55":{},"75":{},"82":{},"90":{}},"description":{"3":{},"14":{},"33":{},"51":{},"52":{},"53":{},"57":{},"90":{}}}],["custom",{"_index":223,"title":{},"description":{"55":{}}}],["cwv",{"_index":142,"title":{},"description":{"42":{}}}],["data",{"_index":45,"title":{},"description":{"8":{},"21":{},"70":{},"97":{}}}],["date",{"_index":99,"title":{},"description":{"23":{},"24":{},"25":{},"27":{}}}],["delet",{"_index":63,"title":{"11":{},"15":{},"37":{},"53":{},"57":{},"79":{},"86":{},"91":{}},"description":{"11":{},"15":{},"37":{},"53":{},"57":{},"91":{}}}],["deliv",{"_index":156,"title":{},"description":{"44":{}}}],["deliveri",{"_index":12,"title":{"5":{}},"description":{"5":{},"44":{},"54":{}}}],["depend",{"_index":146,"title":{},"description":{"42":{}}}],["deprec",{"_index":126,"title":{},"description":{"42":{}}}],["descend",{"_index":72,"title":{},"description":{"13":{},"16":{},"17":{},"18":{},"89":{},"93":{},"94":{},"95":{}}}],["detail",{"_index":93,"title":{"77":{},"84":{}},"description":{"21":{},"97":{}}}],["determin",{"_index":33,"title":{},"description":{"7":{},"28":{},"42":{}}}],["disabl",{"_index":283,"title":{"68":{}},"description":{"68":{}}}],["discov",{"_index":187,"title":{},"description":{"45":{},"46":{}}}],["discoveri",{"_index":169,"title":{"45":{},"46":{}},"description":{}}],["document",{"_index":255,"title":{},"description":{"60":{}}}],["domain",{"_index":51,"title":{},"description":{"8":{},"45":{},"46":{},"70":{}}}],["download",{"_index":252,"title":{"60":{}},"description":{"60":{}}}],["each",{"_index":265,"title":{},"description":{"61":{}}}],["edg",{"_index":164,"title":{},"description":{"44":{},"54":{}}}],["enabl",{"_index":282,"title":{"68":{}},"description":{"68":{}}}],["encod",{"_index":24,"title":{},"description":{"6":{}}}],["endpoint",{"_index":7,"title":{},"description":{"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"31":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"42":{},"44":{},"45":{},"46":{},"49":{},"51":{},"52":{},"53":{},"55":{},"56":{},"57":{},"58":{},"59":{},"60":{},"61":{},"63":{},"68":{},"71":{},"72":{},"89":{},"90":{},"91":{},"93":{},"94":{},"95":{},"97":{}}}],["enhanc",{"_index":131,"title":{},"description":{"42":{}}}],["entiti",{"_index":237,"title":{},"description":{"57":{}}}],["event",{"_index":68,"title":{"13":{},"14":{},"15":{},"44":{},"47":{},"88":{},"89":{},"90":{},"91":{}},"description":{"13":{},"14":{},"15":{},"43":{},"44":{},"47":{},"89":{},"90":{},"91":{}}}],["event/fulfil",{"_index":167,"title":{},"description":{"44":{}}}],["exampl",{"_index":64,"title":{},"description":{"12":{},"29":{}}}],["exist",{"_index":200,"title":{"49":{},"78":{},"85":{}},"description":{"49":{}}}],["experi",{"_index":88,"title":{"21":{},"96":{},"97":{}},"description":{"21":{},"97":{}}}],["field",{"_index":57,"title":{},"description":{"10":{},"36":{}}}],["file",{"_index":222,"title":{},"description":{"55":{},"60":{}}}],["filter",{"_index":287,"title":{"76":{},"83":{}},"description":{}}],["fix",{"_index":293,"title":{"79":{}},"description":{}}],["flow",{"_index":114,"title":{},"description":{"31":{}}}],["follow",{"_index":139,"title":{},"description":{"42":{}}}],["format",{"_index":152,"title":{},"description":{"44":{}}}],["fulfil",{"_index":154,"title":{},"description":{"44":{}}}],["fulfillment_complet",{"_index":151,"title":{"44":{}},"description":{"44":{}}}],["further",{"_index":245,"title":{},"description":{"58":{}}}],["futur",{"_index":128,"title":{},"description":{"42":{}}}],["gateway",{"_index":155,"title":{},"description":{"44":{}}}],["gener",{"_index":256,"title":{},"description":{"60":{}}}],["geo",{"_index":81,"title":{"18":{},"95":{}},"description":{"16":{},"17":{},"93":{},"94":{}}}],["given",{"_index":91,"title":{"23":{},"25":{},"52":{}},"description":{"21":{},"23":{},"25":{},"28":{},"49":{},"56":{},"57":{},"58":{},"59":{},"97":{}}}],["googl",{"_index":112,"title":{"31":{}},"description":{"31":{}}}],["handl",{"_index":161,"title":{},"description":{"44":{}}}],["header",{"_index":173,"title":{},"description":{"45":{},"51":{},"55":{}}}],["hook",{"_index":147,"title":{"43":{},"45":{},"46":{}},"description":{"45":{},"46":{}}}],["hooks/site-detection/cdn/{hooksecret",{"_index":188,"title":{},"description":{"45":{}}}],["hooks/site-detection/rum/{hooksecret",{"_index":190,"title":{},"description":{"46":{}}}],["hooks/site-integration/analytics/{hooksecret",{"_index":196,"title":{},"description":{"47":{}}}],["hoolihan",{"_index":157,"title":{},"description":{"44":{}}}],["https://github.com/adobe/spacecat-api-service/issues/237",{"_index":195,"title":{},"description":{"47":{}}}],["id",{"_index":20,"title":{"9":{},"35":{},"39":{},"40":{}},"description":{"6":{},"9":{},"35":{},"39":{},"40":{},"42":{},"49":{}}}],["identifi",{"_index":19,"title":{},"description":{"6":{},"26":{}}}],["im",{"_index":117,"title":{"39":{},"40":{},"52":{}},"description":{"39":{},"40":{},"49":{},"53":{}}}],["immedi",{"_index":138,"title":{},"description":{"42":{},"58":{}}}],["implement",{"_index":77,"title":{},"description":{"16":{},"17":{},"18":{},"47":{},"61":{},"93":{},"94":{},"95":{}}}],["import",{"_index":217,"title":{"54":{},"55":{},"56":{},"57":{},"58":{},"59":{},"60":{},"61":{}},"description":{"54":{},"55":{},"56":{},"57":{},"58":{},"59":{},"60":{},"61":{}}}],["import-report.xlsx",{"_index":258,"title":{},"description":{"60":{}}}],["import.j",{"_index":220,"title":{},"description":{"55":{}}}],["imports.delet",{"_index":240,"title":{},"description":{"57":{}}}],["includ",{"_index":30,"title":{"7":{}},"description":{"7":{},"8":{},"28":{},"45":{},"46":{},"51":{},"60":{},"70":{}}}],["incom",{"_index":168,"title":{"45":{},"46":{}},"description":{"45":{},"46":{}}}],["inform",{"_index":189,"title":{},"description":{"46":{}}}],["init",{"_index":107,"title":{},"description":{"30":{}}}],["initi",{"_index":175,"title":{},"description":{"45":{},"46":{}}}],["input",{"_index":275,"title":{},"description":{"63":{}}}],["integr",{"_index":192,"title":{"47":{}},"description":{"47":{}}}],["intend",{"_index":160,"title":{},"description":{"44":{}}}],["invit",{"_index":199,"title":{"49":{}},"description":{"49":{}}}],["involv",{"_index":163,"title":{},"description":{"44":{}}}],["item",{"_index":165,"title":{},"description":{"44":{}}}],["itself",{"_index":239,"title":{},"description":{"57":{}}}],["job",{"_index":219,"title":{"55":{},"56":{},"57":{},"58":{},"59":{},"60":{}},"description":{"55":{},"56":{},"57":{},"58":{},"59":{},"60":{}}}],["jobid",{"_index":236,"title":{},"description":{"56":{},"57":{},"58":{},"59":{}}}],["key",{"_index":52,"title":{"13":{},"14":{},"15":{},"51":{},"52":{},"53":{},"88":{},"89":{},"90":{},"91":{}},"description":{"8":{},"13":{},"14":{},"15":{},"50":{},"51":{},"52":{},"53":{},"55":{},"57":{},"70":{},"89":{},"90":{},"91":{}}}],["latest",{"_index":31,"title":{"7":{},"8":{},"23":{},"28":{},"66":{},"70":{}},"description":{"7":{},"8":{},"28":{},"70":{}}}],["lh",{"_index":143,"title":{},"description":{"42":{}}}],["lhs-desktop",{"_index":144,"title":{},"description":{"42":{}}}],["lhs-mobil",{"_index":145,"title":{},"description":{"42":{}}}],["list",{"_index":89,"title":{"74":{},"81":{},"82":{}},"description":{"21":{},"52":{},"97":{}}}],["log",{"_index":171,"title":{"45":{},"46":{}},"description":{"45":{},"46":{}}}],["longer",{"_index":130,"title":{},"description":{"42":{},"53":{}}}],["make",{"_index":266,"title":{},"description":{"61":{}}}],["manag",{"_index":198,"title":{},"description":{"48":{},"50":{}}}],["mani",{"_index":234,"title":{},"description":{"55":{}}}],["map",{"_index":221,"title":{},"description":{"55":{}}}],["mark",{"_index":214,"title":{},"description":{"53":{},"58":{}}}],["maximum",{"_index":276,"title":{},"description":{"63":{}}}],["messag",{"_index":185,"title":{},"description":{"45":{},"46":{}}}],["metric",{"_index":39,"title":{"8":{},"19":{},"20":{},"69":{},"70":{},"71":{},"72":{}},"description":{"8":{},"19":{},"20":{},"70":{},"71":{},"72":{}}}],["monitor",{"_index":44,"title":{},"description":{"8":{},"70":{}}}],["more",{"_index":297,"title":{"82":{}},"description":{}}],["multipl",{"_index":301,"title":{"87":{}},"description":{}}],["new",{"_index":11,"title":{"3":{},"14":{},"33":{},"51":{},"55":{},"75":{},"90":{}},"description":{"3":{},"14":{},"33":{},"51":{},"55":{},"58":{},"90":{}}}],["note",{"_index":264,"title":{},"description":{"61":{}}}],["notifi",{"_index":186,"title":{},"description":{"45":{},"46":{}}}],["number",{"_index":277,"title":{},"description":{"63":{}}}],["object",{"_index":37,"title":{},"description":{"7":{},"28":{}}}],["obtain",{"_index":90,"title":{},"description":{"21":{},"97":{}}}],["on",{"_index":62,"title":{"82":{},"87":{}},"description":{"10":{},"36":{},"42":{}}}],["on-demand",{"_index":134,"title":{},"description":{"42":{}}}],["onc",{"_index":180,"title":{},"description":{"45":{},"46":{},"51":{}}}],["oper",{"_index":4,"title":{},"description":{"1":{},"22":{},"32":{},"41":{},"57":{},"58":{}}}],["opportun",{"_index":285,"title":{"73":{},"74":{},"75":{},"76":{},"77":{},"78":{},"79":{},"81":{},"82":{},"83":{}},"description":{}}],["opportunity-suggest",{"_index":294,"title":{"80":{}},"description":{}}],["option",{"_index":95,"title":{},"description":{"23":{},"24":{},"25":{},"27":{},"55":{}}}],["order",{"_index":78,"title":{},"description":{"16":{},"17":{},"18":{},"23":{},"24":{},"25":{},"27":{},"63":{},"93":{},"94":{},"95":{}}}],["org",{"_index":118,"title":{"39":{},"40":{}},"description":{"39":{},"40":{},"49":{}}}],["organ",{"_index":6,"title":{"2":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"49":{}},"description":{"2":{},"8":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"49":{},"70":{}}}],["organization'",{"_index":201,"title":{},"description":{"49":{}}}],["organizations/by-ims-org-id/{imsorgid",{"_index":119,"title":{},"description":{"39":{}}}],["organizations/by-ims-org-id/{imsorgid}/slack-config",{"_index":122,"title":{},"description":{"40":{}}}],["organizations/{organizationid",{"_index":116,"title":{},"description":{"35":{},"36":{},"37":{}}}],["organizations/{organizationid}/sit",{"_index":9,"title":{},"description":{"2":{},"38":{}}}],["otherwis",{"_index":232,"title":{},"description":{"55":{}}}],["own",{"_index":212,"title":{"52":{}},"description":{}}],["page",{"_index":76,"title":{"16":{},"17":{},"18":{},"20":{},"72":{},"92":{},"93":{},"94":{},"95":{}},"description":{"16":{},"17":{},"18":{},"20":{},"62":{},"72":{},"93":{},"94":{},"95":{}}}],["parallel",{"_index":273,"title":{},"description":{"63":{}}}],["paramet",{"_index":28,"title":{},"description":{"6":{},"42":{}}}],["part",{"_index":257,"title":{},"description":{"60":{}}}],["parti",{"_index":110,"title":{},"description":{"30":{}}}],["particular",{"_index":159,"title":{},"description":{"44":{}}}],["patch",{"_index":242,"title":{"58":{}},"description":{}}],["path",{"_index":22,"title":{},"description":{"6":{}}}],["per",{"_index":58,"title":{},"description":{"10":{},"36":{},"55":{}}}],["permit",{"_index":231,"title":{},"description":{"55":{}}}],["pipelin",{"_index":158,"title":{},"description":{"44":{}}}],["pleas",{"_index":132,"title":{},"description":{"42":{}}}],["pre-sign",{"_index":251,"title":{"60":{}},"description":{}}],["prerequisit",{"_index":205,"title":{},"description":{"49":{}}}],["prevent",{"_index":244,"title":{},"description":{"58":{}}}],["proce",{"_index":183,"title":{},"description":{"45":{},"46":{}}}],["procedur",{"_index":179,"title":{},"description":{"45":{},"46":{}}}],["process",{"_index":150,"title":{"44":{},"45":{},"46":{},"47":{}},"description":{"44":{},"45":{},"46":{},"47":{},"55":{}}}],["produc",{"_index":153,"title":{},"description":{"44":{}}}],["progress",{"_index":249,"title":{"59":{}},"description":{"59":{}}}],["prompt",{"_index":262,"title":{"61":{}},"description":{"61":{}}}],["properti",{"_index":35,"title":{},"description":{"7":{},"26":{}}}],["prototyp",{"_index":272,"title":{},"description":{"63":{}}}],["provid",{"_index":21,"title":{},"description":{"6":{},"10":{},"21":{},"36":{},"49":{},"57":{},"97":{}}}],["queri",{"_index":225,"title":{"56":{},"59":{}},"description":{"55":{},"56":{},"59":{}}}],["queue",{"_index":227,"title":{},"description":{"55":{}}}],["read",{"_index":202,"title":{},"description":{"49":{}}}],["real",{"_index":42,"title":{},"description":{"8":{},"70":{}}}],["receiv",{"_index":149,"title":{},"description":{"43":{},"45":{},"46":{}}}],["recent",{"_index":71,"title":{},"description":{"13":{},"89":{}}}],["redirect",{"_index":113,"title":{},"description":{"31":{}}}],["remov",{"_index":127,"title":{},"description":{"42":{},"57":{}}}],["request",{"_index":59,"title":{"49":{},"60":{}},"description":{"10":{},"36":{},"55":{},"61":{},"63":{}}}],["requir",{"_index":241,"title":{},"description":{"57":{}}}],["respons",{"_index":137,"title":{},"description":{"42":{},"51":{},"55":{},"61":{}}}],["result",{"_index":96,"title":{"60":{}},"description":{"23":{},"24":{},"25":{},"27":{},"58":{},"60":{},"63":{}}}],["retriev",{"_index":5,"title":{"2":{},"4":{},"5":{},"6":{},"7":{},"9":{},"13":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"34":{},"35":{},"38":{},"39":{},"40":{},"71":{},"72":{},"74":{},"76":{},"77":{},"81":{},"83":{},"84":{},"89":{},"93":{},"94":{},"95":{},"97":{}},"description":{"2":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"16":{},"17":{},"18":{},"19":{},"20":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"34":{},"35":{},"38":{},"39":{},"40":{},"70":{},"71":{},"72":{},"93":{},"94":{},"95":{}}}],["return",{"_index":47,"title":{},"description":{"8":{},"13":{},"42":{},"51":{},"55":{},"61":{},"63":{},"70":{},"89":{}}}],["rum",{"_index":41,"title":{"46":{}},"description":{"8":{},"21":{},"46":{},"70":{},"97":{}}}],["run",{"_index":135,"title":{},"description":{"42":{}}}],["same",{"_index":274,"title":{},"description":{"63":{}}}],["sanit",{"_index":178,"title":{},"description":{"45":{},"46":{}}}],["save",{"_index":247,"title":{},"description":{"58":{}}}],["schema",{"_index":61,"title":{},"description":{"10":{},"36":{}}}],["scope",{"_index":209,"title":{},"description":{"51":{},"57":{}}}],["scrape",{"_index":246,"title":{"62":{},"63":{}},"description":{"58":{},"62":{},"63":{}}}],["securitydefinit",{"_index":1,"title":{},"description":{"0":{}}}],["send",{"_index":184,"title":{"61":{}},"description":{"45":{},"46":{},"61":{}}}],["sequenc",{"_index":176,"title":{},"description":{"45":{},"46":{}}}],["servic",{"_index":111,"title":{},"description":{"30":{},"44":{},"54":{},"55":{}}}],["set",{"_index":65,"title":{"63":{}},"description":{"12":{},"29":{},"51":{},"55":{},"63":{}}}],["setup",{"_index":191,"title":{"47":{}},"description":{"47":{}}}],["singl",{"_index":15,"title":{"6":{},"9":{},"26":{},"35":{}},"description":{"26":{},"55":{},"63":{}}}],["site",{"_index":3,"title":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"13":{},"14":{},"16":{},"17":{},"18":{},"19":{},"21":{},"24":{},"25":{},"26":{},"27":{},"28":{},"38":{},"45":{},"46":{},"47":{},"68":{},"70":{},"71":{},"74":{},"75":{},"76":{},"89":{},"90":{},"93":{},"94":{},"95":{},"97":{}},"description":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"13":{},"14":{},"16":{},"17":{},"18":{},"19":{},"21":{},"24":{},"25":{},"26":{},"27":{},"28":{},"38":{},"42":{},"47":{},"68":{},"70":{},"71":{},"89":{},"90":{},"93":{},"94":{},"95":{},"97":{}}}],["sites/by-base-url/{base64baseurl",{"_index":29,"title":{},"description":{"6":{}}}],["sites/by-delivery-type/{deliverytyp",{"_index":14,"title":{},"description":{"5":{}}}],["sites/with-latest-audit/{audittyp",{"_index":38,"title":{},"description":{"7":{}}}],["sites/{siteid",{"_index":55,"title":{},"description":{"9":{},"10":{},"11":{}}}],["sites/{siteid}/audit",{"_index":101,"title":{},"description":{"24":{}}}],["sites/{siteid}/audits/latest",{"_index":104,"title":{},"description":{"27":{}}}],["sites/{siteid}/audits/{audittyp",{"_index":102,"title":{},"description":{"25":{}}}],["sites/{siteid}/audits/{audittype}/{auditedat",{"_index":103,"title":{},"description":{"26":{}}}],["sites/{siteid}/experi",{"_index":94,"title":{},"description":{"21":{},"97":{}}}],["sites/{siteid}/key-ev",{"_index":73,"title":{},"description":{"13":{},"14":{},"89":{},"90":{}}}],["sites/{siteid}/key-events/{keyeventid",{"_index":74,"title":{},"description":{"15":{},"91":{}}}],["sites/{siteid}/latest-audit/{audittyp",{"_index":105,"title":{},"description":{"28":{}}}],["sites/{siteid}/latest-metr",{"_index":54,"title":{},"description":{"8":{},"70":{}}}],["sites/{siteid}/metrics/{metric}/{sourc",{"_index":86,"title":{},"description":{"19":{},"71":{}}}],["sites/{siteid}/metrics/{metric}/{source}/by-url/{base64pageurl",{"_index":87,"title":{},"description":{"20":{},"72":{}}}],["sites/{siteid}/opportun",{"_index":286,"title":{},"description":{"74":{},"75":{}}}],["sites/{siteid}/opportunities/by-status/{statu",{"_index":288,"title":{},"description":{"76":{}}}],["sites/{siteid}/opportunities/{opportunityid",{"_index":289,"title":{},"description":{"77":{},"78":{},"79":{}}}],["sites/{siteid}/opportunities/{opportunityid}/suggest",{"_index":295,"title":{},"description":{"81":{},"82":{}}}],["sites/{siteid}/opportunities/{opportunityid}/suggestions/by-status/{statu",{"_index":299,"title":{},"description":{"83":{}}}],["sites/{siteid}/opportunities/{opportunityid}/suggestions/statu",{"_index":302,"title":{},"description":{"87":{}}}],["sites/{siteid}/opportunities/{opportunityid}/suggestions/{suggestionid",{"_index":300,"title":{},"description":{"84":{},"85":{},"86":{}}}],["sites/{siteid}/top-pag",{"_index":83,"title":{},"description":{"16":{},"93":{}}}],["sites/{siteid}/top-pages/{sourc",{"_index":84,"title":{},"description":{"17":{},"94":{}}}],["sites/{siteid}/top-pages/{source}/{geo",{"_index":85,"title":{},"description":{"18":{},"95":{}}}],["sites/{siteid}/{audittyp",{"_index":67,"title":{},"description":{"12":{},"29":{}}}],["skip",{"_index":66,"title":{},"description":{"12":{},"29":{}}}],["slack",{"_index":120,"title":{"40":{},"48":{},"49":{}},"description":{"40":{},"42":{},"45":{},"46":{},"48":{},"49":{}}}],["slack/channels/invite-by-user-id",{"_index":207,"title":{},"description":{"49":{}}}],["sort",{"_index":97,"title":{},"description":{"23":{},"24":{},"25":{},"27":{}}}],["sourc",{"_index":80,"title":{"17":{},"18":{},"19":{},"20":{},"71":{},"72":{},"94":{},"95":{}},"description":{"16":{},"19":{},"20":{},"71":{},"72":{},"93":{}}}],["spacecat",{"_index":206,"title":{},"description":{"49":{},"51":{}}}],["special",{"_index":26,"title":{},"description":{"6":{}}}],["specif",{"_index":40,"title":{"67":{},"74":{},"75":{},"76":{},"77":{},"78":{},"81":{},"83":{},"84":{},"85":{}},"description":{"8":{},"68":{},"70":{}}}],["start",{"_index":70,"title":{},"description":{"13":{},"55":{},"58":{},"89":{}}}],["statu",{"_index":224,"title":{"56":{},"76":{},"83":{},"87":{}},"description":{"55":{},"56":{},"58":{}}}],["stop",{"_index":243,"title":{},"description":{"58":{}}}],["storag",{"_index":248,"title":{},"description":{"58":{}}}],["success",{"_index":181,"title":{},"description":{"45":{},"46":{}}}],["suggest",{"_index":292,"title":{"79":{},"81":{},"82":{},"83":{},"84":{},"85":{},"86":{},"87":{}},"description":{}}],["summari",{"_index":260,"title":{},"description":{"60":{}}}],["system",{"_index":215,"title":{},"description":{"53":{}}}],["time",{"_index":228,"title":{},"description":{"55":{}}}],["token",{"_index":204,"title":{},"description":{"49":{}}}],["tools/api-key",{"_index":211,"title":{},"description":{"51":{},"52":{}}}],["tools/api-keys/{apikeyid",{"_index":216,"title":{},"description":{"53":{}}}],["tools/import/assistant/prompt",{"_index":270,"title":{},"description":{"61":{}}}],["tools/import/job",{"_index":235,"title":{},"description":{"55":{}}}],["tools/import/jobs/{jobid",{"_index":226,"title":{},"description":{"55":{},"56":{},"57":{},"58":{}}}],["tools/import/jobs/{jobid}/progress",{"_index":250,"title":{},"description":{"59":{}}}],["tools/import/jobs/{jobid}/result",{"_index":261,"title":{},"description":{"60":{}}}],["top",{"_index":75,"title":{"16":{},"17":{},"18":{},"92":{},"93":{},"94":{},"95":{}},"description":{"16":{},"17":{},"18":{},"93":{},"94":{},"95":{}}}],["traffic",{"_index":46,"title":{},"description":{"8":{},"16":{},"17":{},"18":{},"70":{},"93":{},"94":{},"95":{}}}],["transact",{"_index":298,"title":{"82":{},"87":{}},"description":{}}],["trigger",{"_index":123,"title":{"41":{},"42":{}},"description":{"41":{},"42":{}}}],["type",{"_index":13,"title":{"5":{},"23":{},"25":{}},"description":{"5":{},"23":{},"25":{},"26":{},"28":{},"42":{},"68":{}}}],["unavail",{"_index":230,"title":{},"description":{"55":{}}}],["uniqu",{"_index":18,"title":{},"description":{"6":{}}}],["updat",{"_index":56,"title":{"10":{},"12":{},"29":{},"36":{},"78":{},"85":{},"87":{}},"description":{"10":{},"12":{},"29":{},"36":{}}}],["upon",{"_index":174,"title":{},"description":{"45":{},"46":{}}}],["url",{"_index":17,"title":{"6":{},"60":{},"63":{}},"description":{"6":{},"12":{},"29":{},"42":{},"46":{},"55":{},"57":{},"58":{},"61":{},"63":{}}}],["us",{"_index":8,"title":{},"description":{"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"9":{},"10":{},"11":{},"12":{},"16":{},"17":{},"18":{},"19":{},"20":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"31":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"42":{},"44":{},"49":{},"51":{},"52":{},"53":{},"55":{},"56":{},"57":{},"58":{},"59":{},"60":{},"61":{},"68":{},"71":{},"72":{},"93":{},"94":{},"95":{}}}],["user",{"_index":43,"title":{},"description":{"8":{},"31":{},"49":{},"58":{},"70":{}}}],["valid",{"_index":177,"title":{},"description":{"45":{},"46":{},"53":{}}}],["valu",{"_index":49,"title":{},"description":{"8":{},"45":{},"70":{}}}],["version",{"_index":129,"title":{"67":{}},"description":{"42":{}}}],["via",{"_index":194,"title":{},"description":{"47":{},"49":{}}}],["warn",{"_index":124,"title":{},"description":{"42":{},"63":{}}}],["web",{"_index":271,"title":{},"description":{"62":{}}}],["webhook",{"_index":148,"title":{},"description":{"43":{},"45":{},"46":{}}}],["within",{"_index":82,"title":{},"description":{"16":{},"17":{},"93":{},"94":{}}}],["x-api-key",{"_index":210,"title":{},"description":{"51":{}}}],["x-forwarded-host",{"_index":172,"title":{},"description":{"45":{}}}],["zero",{"_index":48,"title":{},"description":{"8":{},"70":{}}}],["zip",{"_index":253,"title":{"60":{}},"description":{}}]],"pipeline":[]}},"options":{"hideRequestPayloadSample":false}};
+      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.1.0","info":{"version":"1.90.0","title":"SpaceCat API","description":"The SpaceCat API is used to manage edge delivery site directory and obtain audit information.\n\n## Authentication\n<SecurityDefinitions />\n","termsOfService":"https://www.adobe.com/go/experiencecloudterms","contact":{"name":"Spacecat Team","url":"https://github.com/adobe/spacecat-api-service"},"x-logo":{"url":"https://solaris007.github.io/spacecat-ui/spacecat_logo_192.webp","altText":"SpaceCat logo"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"servers":[{"url":"https://spacecat.experiencecloud.live/api/ci","description":"Development server"},{"url":"https://spacecat.experiencecloud.live/api/v1","description":"Production server"}],"tags":[{"name":"site","description":"Site operations"},{"name":"audit","description":"Audit operations"},{"name":"auth","description":"Init authentication against 3rd party services"},{"name":"organization","description":"Organization operations"},{"name":"trigger","description":"Trigger operations"},{"name":"hooks","description":"Webhooks for receiving events"},{"name":"slack","description":"Slack channel management"},{"name":"api-keys","description":"API key management"},{"name":"import","description":"APIs for importing content to Edge Delivery Services"},{"name":"scrape","description":"APIs for scraping web pages"}],"paths":{"/audits/latest/{auditType}":{"parameters":[{"$ref":"#/components/parameters/auditType"},{"$ref":"#/components/parameters/ascending"}],"get":{"tags":["audit"],"summary":"Retrieve all latest audits of a given type","description":"This endpoint is useful for retrieving all audits of a given type.\nOptionally, the results can be sorted in ascending order by audited at date.\n","operationId":"getAllAudits","responses":{"200":{"description":"A list of audits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditList"}}}},"400":{"$ref":"#/components/responses/400-no-audit-type"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/auth/google/{siteId}":{"parameters":[{"$ref":"#/components/parameters/siteId"}],"get":{"tags":["auth"],"summary":"Authenticate with Google","description":"This endpoint is used to authenticate with Google.\nThe user will be redirected to the Google authentication flow.\n","operationId":"googleAuth","responses":{"200":{"description":"Successful operation and token has been saved"},"302":{"description":"Redirect to Google authentication flow"},"400":{"description":"Missing or invalid parameters"},"404":{"description":"Site matching site found in Google Search Console"},"500":{"$ref":"#/components/responses/500"}},"security":[]}},"/configurations":{"get":{"tags":["configuration"],"summary":"Get all application configurations","operationId":"getAllConfigurations","security":[{"admin_key":[]}],"responses":{"200":{"description":"A list of all known configurations or empty list if no configurations are present.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Configuration"}}}}},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}}}},"/configurations/latest":{"get":{"tags":["configuration"],"summary":"Get the latest application configuration","operationId":"getLatestConfiguration","security":[{"admin_key":[]}],"responses":{"200":{"description":"The latest application configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Configuration"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"description":"Latest configuration not found."},"500":{"$ref":"#/components/responses/500"}}}},"/configurations/{version}":{"get":{"tags":["configuration"],"summary":"Get a specific version of the application configuration","operationId":"getConfigurationByVersion","security":[{"admin_key":[]}],"parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Specific version of the application configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Configuration"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-configuration-not-found-with-version"},"500":{"$ref":"#/components/responses/500"}}}},"/configurations/sites/audits":{"patch":{"tags":["configuration"],"summary":"Enable or disable audits for sites","description":"Use this endpoint to enable or disable specific audit types for your sites.\n","operationId":"update","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"baseURL":{"$ref":"#/components/schemas/URL"},"auditType":{"type":"string","description":"The type of audit to be enabled or disabled.","examples":["cwv",404,"broken-backlinks"]},"enable":{"type":"boolean","description":"Set to true to enable the audit, or false to disable it."}},"required":["baseURL","auditType","enable"]}}}}},"responses":{"207":{"description":"A list of baseURL, the status of the update, and the corresponding site if successful, or the error message if failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigurationSitesAuditsUpdateResult"}}}},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"admin_key":[]}]}},"/event/fulfillment":{"post":{"tags":["hooks"],"summary":"Process fulfillment_completed events","description":"This endpoint can be used to process an array of fulfillment_completed\nevents, in the format produced by the Fulfillment Gateway and \ndelivered by the Hoolihan pipeline. In particular, it is intended to \nbe used to handle contract fulfillment events which involve an Edge \nDelivery Services fulfillable item \"code\".\n","operationId":"processFulfillmentEvents","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HoolihanEvents"}}}},"responses":{"202":{"description":"Accepted for processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FulfillmentProcessingResults"}}}},"400":{"$ref":"#/components/responses/400-bad-hoolihan-event"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"admin_key":[]}]}},"/hooks/site-detection/cdn/{hookSecret}":{"parameters":[{"$ref":"#/components/parameters/hookSecret"}],"post":{"tags":["hooks"],"summary":"Process incoming site discovery hooks from CDN logs","description":"This endpoint processes hooks that include x-forwarded-host header value from CDN logs \nUpon receiving the incoming webhook, it initiates a sequence of validation and sanitization procedures\nOnce successful sanitization and validation are completed, \nit proceeds to send a Slack message notifying about the discovered domain\n","operationId":"siteDetectionCdn","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CDNXForwardedHostAlert"}}}},"responses":{"202":{"description":"hook is accepted"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/hooks/site-detection/rum/{hookSecret}":{"parameters":[{"$ref":"#/components/parameters/hookSecret"}],"post":{"tags":["hooks"],"summary":"Process incoming site discovery hooks from RUM logs","description":"This endpoint processes hooks that include URL and domain information from RUM logs \nUpon receiving the incoming webhook, it initiates a sequence of validation and sanitization procedures\nOnce successful sanitization and validation are completed, \nit proceeds to send a Slack message notifying about the discovered domain\n","operationId":"siteDetectionRum","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RUMDomainDiscoveryAlert"}}}},"responses":{"202":{"description":"hook is accepted"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/hooks/site-integration/analytics/{hookSecret}":{"parameters":[{"$ref":"#/components/parameters/hookSecret"}],"post":{"tags":["hooks"],"summary":"Process setup completed events for site integration with analytics","description":"Not implemented yet (will be via https://github.com/adobe/spacecat-api-service/issues/237).\nProcess setup completed events for site integration with analytics.\n","operationId":"processAnalyticsSiteIntegration","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsSiteIntegration"},"examples":{"analytics-site-integration-aa-tags":{"$ref":"#/components/examples/analytics-site-integration-aa-tags"},"analytics-site-integration-aa-aep-websdk":{"$ref":"#/components/examples/analytics-site-integration-aa-aep-websdk"},"analytics-site-integration-cja-tags":{"$ref":"#/components/examples/analytics-site-integration-cja-tags"},"analytics-site-integration-cja-websdk":{"$ref":"#/components/examples/analytics-site-integration-cja-websdk"}}}}},"responses":{"202":{"description":"Accepted for processing"},"400":{"$ref":"#/components/responses/400-no-site-id"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/organizations":{"post":{"tags":["organization"],"summary":"Create a new organization","description":"This endpoint is useful for creating a new organization.\n","operationId":"createOrganization","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationCreate"}}}},"responses":{"201":{"description":"Organization created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"400":{"$ref":"#/components/responses/400-empty-request-body-validation-failure"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"admin_key":[]}]},"get":{"tags":["organization"],"summary":"Retrieve all organizations","description":"This endpoint is useful for retrieving all organizations.\n","operationId":"getOrganizations","responses":{"200":{"description":"A list of organizations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationList"}}}},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/organizations/{organizationId}":{"parameters":[{"$ref":"#/components/parameters/organizationId"}],"get":{"tags":["organization"],"summary":"Retrieve a single organization by its ID","description":"This endpoint is useful for retrieving an organization by its ID.\n","operationId":"getOrganization","responses":{"200":{"description":"Successful operation with an organization object returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"400":{"$ref":"#/components/responses/400-no-organization-id"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-organization-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]},"patch":{"tags":["organization"],"summary":"Update an organization","description":"This endpoint is useful for updating an organization.\nOnly the fields as per the request body schema will be updated.\nAt least one field to update must be provided in the request body.\n","operationId":"patchOrganization","security":[{"admin_key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationUpdate"}}}},"responses":{"200":{"description":"Organization updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"400":{"$ref":"#/components/responses/400-no-organization-id-request-body-no-updates"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-organization-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"tags":["organization"],"summary":"Delete an organization","description":"This endpoint is useful for deleting an organization.\n","operationId":"deleteOrganization","security":[{"admin_key":[]}],"responses":{"204":{"description":"Organization deleted successfully"},"400":{"$ref":"#/components/responses/400-no-organization-id"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-organization-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}}}},"/organizations/{organizationId}/sites":{"parameters":[{"$ref":"#/components/parameters/organizationId"}],"get":{"tags":["organization","site"],"summary":"Retrieve all sites for an organization","description":"This endpoint is useful for retrieving all sites for an organization.\n","operationId":"getSitesForOrganization","responses":{"200":{"description":"A list of sites","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteList"}}}},"400":{"$ref":"#/components/responses/400-no-organization-id"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-organization-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/organizations/by-ims-org-id/{imsOrgId}":{"parameters":[{"$ref":"#/components/parameters/imsOrgId"}],"get":{"tags":["organization"],"summary":"Retrieve an organization by IMS Org ID","description":"This endpoint is useful for retrieving an organization by IMS Org ID.\n","operationId":"getOrganizationByImsOrgId","responses":{"200":{"description":"Successful operation with an organization object returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"400":{"$ref":"#/components/responses/400-bad-ims-org-id"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/organizations/by-ims-org-id/{imsOrgId}/slack-config":{"parameters":[{"$ref":"#/components/parameters/imsOrgId"}],"get":{"tags":["organization"],"summary":"Retrieve Slack config for an organization by IMS Org ID","description":"This endpoint is useful for retrieving the Slack config of an \norganization by IMS Org ID.\n","operationId":"getSlackConfigByImsOrgId","responses":{"200":{"description":"Successful operation with a Slack config object returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlackConfig"}}}},"204":{"description":"No Slack config found for this IMS Org ID"},"400":{"$ref":"#/components/responses/400-bad-ims-org-id"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/scrape":{"post":{"tags":["scrape"],"summary":"Scrape a set of URLs","description":"Warning: prototype endpoint. \nThis endpoint allows you to scrape a set of URLs. The URLs are scraped in parallel and the results are returned in the same order as the input.\nThe maximum number of URLs that can be scraped in a single request is 10.\n","operationId":"scrape","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScrapeRequest"}}}},"responses":{"200":{"description":"A list of scrape results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScrapeResponse"}}}},"400":{"$ref":"#/components/responses/400-max-scrape-urls-exceeded"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites":{"post":{"tags":["site"],"summary":"Create a new site","description":"This endpoint is useful for creating a new site.\n","operationId":"createSite","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteCreate"}}}},"responses":{"201":{"description":"Site created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Site"}}}},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"admin_key":[]}]},"get":{"tags":["site"],"summary":"Retrieve all sites","description":"This endpoint is useful for retrieving all sites.\n","operationId":"getSites","responses":{"200":{"description":"A list of sites","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteList"}}}},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/by-delivery-type/{deliveryType}":{"parameters":[{"$ref":"#/components/parameters/deliveryType"}],"get":{"tags":["site"],"summary":"Retrieve all sites by delivery type","description":"This endpoint is useful for retrieving all sites by delivery type.\n","operationId":"getSitesByDeliveryType","responses":{"200":{"description":"A list of sites","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteList"}}}},"400":{"$ref":"#/components/responses/400-no-delivery-type"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/by-base-url/{base64BaseUrl}":{"parameters":[{"$ref":"#/components/parameters/base64BaseUrl"}],"get":{"tags":["site"],"summary":"Retrieve a single site by its Base URL","description":"This endpoint is useful for retrieving a site when you only have its Base URL. The Base URL is a unique identifier for a site other than the Site ID.\nThe base URL provided in the path must be base64 encoded. This is to allow for URLs with special characters to be used as path parameters.\n","operationId":"getSiteByBaseUrl","responses":{"200":{"description":"Successful operation with a site object returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Site"}}}},"400":{"$ref":"#/components/responses/400-no-base-url"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-base-url"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/with-latest-audit/{auditType}":{"parameters":[{"$ref":"#/components/parameters/auditType"}],"get":{"tags":["site"],"summary":"Retrieve all sites including their latest audit","description":"This endpoint is useful for retrieving all sites including their latest audit.\nThe latest audit is determined by the auditedAt property of the audit and\nincluded in the audits array of the site object.\n","operationId":"getSitesWithLatestAudit","responses":{"200":{"description":"A list of sites with their latest audit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteWithLatestAuditList"}}}},"400":{"$ref":"#/components/responses/400-no-audit-type"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/latest-metrics":{"get":{"summary":"Get latest site metrics","description":"Retrieves the latest metrics for a specific site, including RUM (Real User Monitoring)\ndata and organic traffic metrics. Returns zeroed values if no data is available or\nno RUM domain key is configured.\n","parameters":[{"$ref":"#/components/parameters/siteId"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"pageViewsChange":{"type":"number","description":"Percentage change in page views compared to the previous period"},"ctrChange":{"type":"number","description":"Percentage change in Click-Through Rate (CTR) compared to the previous period"},"projectedTrafficValue":{"type":"number","description":"Projected traffic value based on page views change and cost per click"}}}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}],"tags":["metrics","site"]}},"/sites/{siteId}":{"parameters":[{"$ref":"#/components/parameters/siteId"}],"get":{"tags":["site"],"summary":"Retrieve a single site by its ID","description":"This endpoint is useful for retrieving a site by its ID.\n","operationId":"getSite","responses":{"200":{"description":"Successful operation with a site object returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Site"}}}},"400":{"$ref":"#/components/responses/400-no-site-id"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]},"patch":{"tags":["site"],"summary":"Update a site","description":"This endpoint is useful for updating a site.\nOnly the fields as per the request body schema will be updated.\nAt least one field to update must be provided in the request body.\n","operationId":"patchSite","security":[{"admin_key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteUpdate"}}}},"responses":{"200":{"description":"Site updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Site"}}}},"400":{"$ref":"#/components/responses/400-no-site-id-request-body-no-updates"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"tags":["site"],"summary":"Delete a site","description":"This endpoint is useful for deleting a site.\n","operationId":"deleteSite","security":[{"admin_key":[]}],"responses":{"204":{"description":"Site deleted successfully"},"400":{"$ref":"#/components/responses/400-no-site-id"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}}}},"/sites/{siteId}/audits":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/ascending"}],"get":{"tags":["audit"],"summary":"Retrieve all audits for a site","description":"This endpoint is useful for retrieving all audits for a site.\nOptionally, the results can be sorted in ascending order by audited at date.\n","operationId":"getAllAuditsForSite","responses":{"200":{"description":"A list of audits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditList"}}}},"400":{"$ref":"#/components/responses/400-no-site-id"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/audits/{auditType}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/auditType"},{"$ref":"#/components/parameters/ascending"}],"get":{"tags":["audit"],"summary":"Retrieve all audits of a given type for a site","description":"This endpoint is useful for retrieving all audits of a given type for a site.\nOptionally, the results can be sorted in ascending order by audited at date.\n","operationId":"getAllAuditsOfTypeForSite","responses":{"200":{"description":"A list of audits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditList"}}}},"400":{"$ref":"#/components/responses/400-no-site-id"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/audits/{auditType}/{auditedAt}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/auditType"},{"$ref":"#/components/parameters/auditedAt"}],"get":{"tags":["audit"],"summary":"Retrieve a single audit for a site","description":"This endpoint is useful for retrieving a single audit for a site.\nThe audit is identified by the auditedAt property of the audit and\nthe audit type.\n","operationId":"getAuditForSite","responses":{"200":{"description":"An audit object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audit"},"examples":{"generic-audit":{"$ref":"#/components/examples/generic-audit"},"broken-backlinks-audit":{"$ref":"#/components/examples/broken-backlinks-audit"},"costs-audit":{"$ref":"#/components/examples/costs-audit"},"meta-tags-audit":{"$ref":"#/components/examples/meta-tags-audit"},"broken-internal-links-audit":{"$ref":"#/components/examples/broken-internal-links-audit"}}}}},"400":{"$ref":"#/components/responses/400-audit-for-site"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-audit-not-found"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/audits/latest":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/ascending"}],"get":{"tags":["audit"],"summary":"Retrieve all audits for a site","description":"This endpoint is useful for retrieving all audits for a site.\nOptionally, the results can be sorted in ascending order by audited at date.\n","operationId":"getAllAuditsForSite","responses":{"200":{"description":"A list of audits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditList"}}}},"400":{"$ref":"#/components/responses/400-no-site-id"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/latest-audit/{auditType}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/auditType"}],"get":{"tags":["audit"],"summary":"Retrieve the latest audit for a site","description":"This endpoint is useful for retrieving the latest audit for a site.\nThe latest audit is determined by the given audit type and will be \nincluded in the audits array of the site object.\n","operationId":"getLatestAuditForSite","responses":{"200":{"description":"An audit object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audit"},"examples":{"generic-audit":{"$ref":"#/components/examples/generic-audit"},"broken-backlinks-audit":{"$ref":"#/components/examples/broken-backlinks-audit"},"costs-audit":{"$ref":"#/components/examples/costs-audit"},"meta-tags-audit":{"$ref":"#/components/examples/meta-tags-audit"},"broken-internal-links-audit":{"$ref":"#/components/examples/broken-internal-links-audit"}}}}},"400":{"$ref":"#/components/responses/400-latest-audit-for-site"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-audit-not-found"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/{auditType}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/auditType"}],"patch":{"tags":["audit","site"],"summary":"Update the configuration for an audit","description":"This endpoint is useful for updating the configuration for an audit, \nfor example to set which URLs to skip from the audit.\n","operationId":"patchAuditForSite","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateHandlerTypeConfig"}}}},"responses":{"200":{"description":"The updated audit type config object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandlerConfig"}}}},"400":{"$ref":"#/components/responses/400-patch-audit-for-site"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-audit-not-found"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/opportunities":{"parameters":[{"$ref":"#/components/parameters/siteId"}],"get":{"summary":"Retrieve a list of all opportunities for a specific site\n","tags":["opportunities"],"responses":{"200":{"description":"A list of opportunities","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpportunityList"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"ims_key":[]}]},"post":{"summary":"Create a new opportunity for a specific site\n","tags":["opportunities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpportunityCreate"},"examples":{"broken-backlinks-opportunity":{"$ref":"#/components/examples/broken-backlinks-opportunity-create"}}}}},"responses":{"201":{"description":"Opportunity created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Opportunity"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"ims_key":[]}]}},"/sites/{siteId}/opportunities/by-status/{status}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"name":"status","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"Retrieve opportunities for a specific site filtered by status\n","tags":["opportunities"],"responses":{"200":{"description":"A list of opportunities filtered by status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpportunityList"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"ims_key":[]}]}},"/sites/{siteId}/opportunities/{opportunityId}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/opportunityId"}],"get":{"summary":"Retrieve details of a specific opportunity\n","tags":["opportunities"],"responses":{"200":{"description":"Details of the opportunity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Opportunity"},"examples":{"broken-backlinks-opportunity":{"$ref":"#/components/examples/broken-backlinks-opportunity"}}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"ims_key":[]}]},"patch":{"summary":"Update specific attributes of an existing opportunity\n","tags":["opportunities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpportunityUpdate"},"examples":{"broken-backlinks-opportunity-update":{"$ref":"#/components/examples/broken-backlinks-opportunity-update"}}}}},"responses":{"200":{"description":"Opportunity updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Opportunity"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"ims_key":[]}]},"delete":{"summary":"Delete an opportunity and associated suggestions + fixes\n","tags":["opportunities"],"responses":{"204":{"description":"Opportunity deleted"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"ims_key":[]}]}},"/sites/{siteId}/opportunities/{opportunityId}/suggestions":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/opportunityId"}],"get":{"summary":"Retrieve a list of all suggestions for a specific opportunity\n","tags":["opportunity-suggestions"],"responses":{"200":{"description":"A list of suggestions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestionList"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"ims_key":[]}]},"post":{"summary":"Create and add a list of one or more suggestions to an opportunity in one transaction\n","tags":["opportunity-suggestions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestionCreateList"},"examples":{"broken-backlinks-suggestion-create-list":{"$ref":"#/components/examples/broken-backlinks-suggestion-create-list"}}}}},"responses":{"207":{"description":"A list of suggestions created and added to the opportunity, \nor the status code and error message for the ones failed.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestionCreateListResponse"},"examples":{"broken-backlinks-suggestion-create-list-response":{"$ref":"#/components/examples/broken-backlinks-suggestion-create-list-response"}}}}}},"security":[{"ims_key":[]}]}},"/sites/{siteId}/opportunities/{opportunityId}/suggestions/by-status/{status}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/opportunityId"},{"name":"status","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"Retrieve suggestions for a specific opportunity filtered by status\n","tags":["opportunity-suggestions"],"responses":{"200":{"description":"A list of suggestions filtered by status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestionList"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"ims_key":[]}]}},"/sites/{siteId}/opportunities/{opportunityId}/suggestions/{suggestionId}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/opportunityId"},{"$ref":"#/components/parameters/suggestionId"}],"get":{"summary":"Retrieve details of a specific suggestion\n","tags":["opportunity-suggestions"],"responses":{"200":{"description":"Details of the suggestion","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Suggestion"},"examples":{"broken-backlinks-suggestion":{"$ref":"#/components/examples/broken-backlinks-suggestion"}}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"ims_key":[]}]},"patch":{"summary":"Update specific attributes of an existing suggestion\n","tags":["opportunity-suggestions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestionUpdate"},"examples":{"broken-backlinks-suggestion-update":{"$ref":"#/components/examples/broken-backlinks-suggestion-update"}}}}},"responses":{"200":{"description":"Suggestion updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Suggestion"},"examples":{"broken-backlinks-suggestion":{"$ref":"#/components/examples/broken-backlinks-suggestion"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"ims_key":[]}]},"delete":{"summary":"Delete a suggestion\n","tags":["opportunity-suggestions"],"responses":{"204":{"description":"Suggestion deleted"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}},"security":[{"ims_key":[]}]}},"/sites/{siteId}/opportunities/{opportunityId}/suggestions/status":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/opportunityId"}],"patch":{"summary":"Update the status of one or multiple suggestions in one transaction\n","tags":["opportunity-suggestions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestionStatusUpdate"},"examples":{"broken-backlinks-suggestions-status-update":{"$ref":"#/components/examples/broken-backlinks-suggestions-status-update"}}}}},"responses":{"207":{"description":"A list of suggestions updated, \nor the status code and error message for the ones failed.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestionStatusUpdateListResponse"},"examples":{"broken-backlinks-suggestions-status-update-response":{"$ref":"#/components/examples/broken-backlinks-suggestions-status-update-response"}}}}}},"security":[{"ims_key":[]}]}},"/sites/{siteId}/key-events":{"parameters":[{"$ref":"#/components/parameters/siteId"}],"get":{"tags":["site","key event"],"summary":"Retrieve key events for a site","description":"This endpoint returns key events for a site chronologically, starting from the most recent and descending to the least recent\n","operationId":"getKeyEvents","responses":{"200":{"description":"A list of key events for the requested sites","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyEventsList"}}}},"400":{"$ref":"#/components/responses/400-no-site-id"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]},"post":{"tags":["site","key event"],"summary":"Create a new key event for a site","description":"The endpoint for creating new key events for a site\n","operationId":"createKeyEvent","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyEventCreate"}}}},"responses":{"201":{"description":"Key event created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyEvent"}}}},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/key-events/{keyEventId}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/keyEventId"}],"delete":{"tags":["site","key event"],"summary":"Delete a key event","description":"The endpoint for deleting a key event\n","operationId":"deleteKeyEvent","security":[{"api_key":[]}],"responses":{"204":{"description":"Key event deleted successfully"},"400":{"$ref":"#/components/responses/400-no-key-event-id"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-key-event-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}}}},"/sites/{siteId}/top-pages":{"parameters":[{"$ref":"#/components/parameters/siteId"}],"get":{"tags":["site","top pages"],"summary":"Retrieve top pages for site","description":"Not implemented yet.\nThis endpoint is useful for retrieving top pages for a site.\nThe top pages will be ordered in buckets by source and geo,\nand in descending order by traffic within these buckets.\n","operationId":"getSiteTopPages","responses":{"200":{"description":"A list of site top pages","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteTopPageList"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/top-pages/{source}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/source"}],"get":{"tags":["site","top pages"],"summary":"Retrieve top pages for site by source","description":"Not implemented yet.\nThis endpoint is useful for retrieving top pages for a site.\nThe top pages will be ordered in buckets by geo,\nand in descending order by traffic within these buckets.\n","operationId":"getSiteTopPagesBySource","responses":{"200":{"description":"A list of site top pages","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteTopPageList"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/top-pages/{source}/{geo}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/source"},{"$ref":"#/components/parameters/geo"}],"get":{"tags":["site","top pages"],"summary":"Retrieve top pages for site by source and geo","description":"Not implemented yet.\nThis endpoint is useful for retrieving top pages for a site.\nThe top pages will be ordered in descending order by traffic.\n","operationId":"getSiteTopPagesBySourceAndGeo","responses":{"200":{"description":"A list of site top pages","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteTopPageList"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/metrics/{metric}/{source}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/source"},{"$ref":"#/components/parameters/metric"}],"get":{"tags":["metrics","site"],"summary":"Retrieve site metrics by source","description":"This endpoint is useful for retrieving site metrics by source.\n","operationId":"getSiteMetricsBySource","responses":{"200":{"description":"A list of site metrics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteMetricList"}}}},"400":{"$ref":"#/components/responses/400-no-site-id"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/metrics/{metric}/{source}/by-url/{base64PageUrl}":{"parameters":[{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/source"},{"$ref":"#/components/parameters/metric"},{"$ref":"#/components/parameters/base64PageUrl"}],"get":{"tags":["metrics","site"],"summary":"Retrieve page metrics by source","description":"This endpoint is useful for retrieving page metrics by source.\nCurrently only `organic-keywords` is supported as a metric.\n","operationId":"getPageMetricsBySource","responses":{"200":{"description":"A list of page metrics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageMetricList"}}}},"400":{"$ref":"#/components/responses/400-no-site-id"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/sites/{siteId}/experiments":{"parameters":[{"$ref":"#/components/parameters/siteId"}],"get":{"tags":["site","experiments"],"summary":"Retrieves all experiments for the site","description":"This endpoint provide a list of experiments obtained from RUM data for the given site along with all the experiment details.\n","operationId":"getExperiments","responses":{"200":{"description":"A list of site experiments","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteExperimentList"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-site-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}},"security":[{"api_key":[]}]}},"/slack/channels/invite-by-user-id":{"post":{"tags":["slack"],"summary":"Request invitation to an existing Slack channel of an organization","description":"This endpoint can be used to invite a user to their organization's Slack \nchannel by IMS user ID, which is read from the IMS API via the provided \nuser access token. As a prerequisite, there must be an existing Spacecat \norganization and Slack channel for the given IMS org ID.\n","operationId":"inviteToSlackChannelByUserId","security":[{"admin_key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlackInviteToChannelByUserIdRequest"}}}},"responses":{"202":{"description":"Request accepted, invite(s) to follow by email if successful"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404-organization-not-found-with-id"},"500":{"$ref":"#/components/responses/500"}}}},"/trigger":{"parameters":[{"$ref":"#/components/parameters/triggerUrl"},{"$ref":"#/components/parameters/triggerType"}],"get":{"tags":["trigger"],"summary":"Trigger an audit","deprecated":true,"description":"**Warning:** This API is deprecated, will be removed in future versions and should no longer be used or enhanced.\nPlease use the Slack commands to trigger audits on-demand.\n\nThis endpoint is useful for triggering an audit.\nThe audit will be run asynchronously and the response will be returned immediately.\n\nThe audit type is determined by the type parameter and must be one of the following:\n  - 404\n  - apex\n  - cwv\n  - lhs\n  - lhs-desktop\n  - lhs-mobile\n\nThe URL can be either a site ID or a base URL depending on the audit type.\n","operationId":"triggerAudit","responses":{"200":{"description":"Audit triggered successfully"},"400":{"$ref":"#/components/responses/400-missing-params-or-unknown-audit-type"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"admin_key":[]}]}},"/tools/api-keys":{"post":{"tags":["api-keys"],"summary":"Create a new API key","description":"This endpoint can be used to create a new API key with a set of scopes. The scoped API key will be\nreturned in the response only once. The scoped API key can be used to authenticate the Spacecat APIs by\nincluding it in the x-api-key header.\n","operationId":"createApiKey","security":[{"ims_key":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyRequest"}}}},"parameters":[{"in":"header","name":"x-gw-ims-org-id","schema":{"type":"string"},"description":"IMS Organization Id of the client.\n","example":"1234567890ABCDEF12345678@AdobeOrg"}],"responses":{"201":{"description":"API key created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyResponse"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403-max-api-keys-exceeded"},"500":{"$ref":"#/components/responses/500"}}},"get":{"tags":["api-keys"],"summary":"Get all API keys owned by the given IMS client","description":"This endpoint can be used to list all the API keys created by the client.\n","operationId":"getApiKeys","security":[{"ims_key":[]}],"parameters":[{"in":"header","name":"x-gw-ims-org-id","schema":{"type":"string"},"description":"IMS Organization Id of the client.\n","example":"1234567890ABCDEF12345678@AdobeOrg"}],"responses":{"200":{"description":"API key metadata returned successfully. Note that the API key itself will not be included in this list, as it's only displayed once (at creation).\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiKeyMetadataResponse"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}}}},"/tools/api-keys/{apiKeyId}":{"delete":{"tags":["api-keys"],"summary":"Delete an API key","description":"This endpoint can be used to delete an API key. The API key will be marked as deleted in the system and\nwill no longer be valid for authentication. Only keys created by this IMS client can be deleted by it.\n","operationId":"deleteApiKey","security":[{"ims_key":[]}],"parameters":[{"$ref":"#/components/parameters/apiKeyId"},{"in":"header","name":"x-gw-ims-org-id","schema":{"type":"string"},"description":"IMS Organization Id of the client.\n","example":"1234567890ABCDEF12345678@AdobeOrg"}],"responses":{"204":{"description":"API key deleted successfully."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/tools/import/jobs":{"post":{"tags":["import"],"summary":"Create a new import job","description":"This endpoint can be used to start a new import job with a set of URLs, import API key,\noptional import.js mapping file, and optional custom headers. The import job will be processed \nasynchronously and the status of the job can be queried at the /tools/import/jobs/{jobId} endpoint.\nIf there is no import queue available at the time of the request, a 503 Service Unavailable response will\nbe returned. A single import job per client is permitted, otherwise a 429 Too Many Requests\nresponse will be returned.\n","operationId":"startImportJob","security":[{"scoped_api_key":[]}],"parameters":[{"in":"header","name":"x-api-key","schema":{"type":"string"},"description":"Client-specific import API key. This same key will be required to fetch the job status, \nand final .zip result.\n"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImportJobRequest"}}}},"responses":{"202":{"description":"Import job accepted for processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportJobStatus"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}}}},"/tools/import/jobs/{jobId}":{"get":{"tags":["import"],"summary":"Query the status of an import job","description":"This endpoint can be used to query the status of an import job, given its jobId.\n","operationId":"getImportJobStatus","security":[{"scoped_api_key":[]}],"parameters":[{"$ref":"#/components/parameters/jobId"},{"in":"header","name":"x-api-key","schema":{"type":"string"},"description":"Client-specific import API key. Must match the key used to start the import job.\n"}],"responses":{"200":{"description":"Successful operation with an import status object returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportJobStatus"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"tags":["import"],"summary":"Delete an import job","description":"This endpoint can be used to delete an import job, given its jobId. This operation will remove\nall import URL entities in addition to the import job itself. The `imports.delete` scope is \nrequired on the API key used to delete the import job, and only jobs created by the provided\nkey can be deleted.\n","operationId":"deleteImportJob","security":[{"scoped_api_key":[]}],"parameters":[{"$ref":"#/components/parameters/jobId"},{"in":"header","name":"x-api-key","schema":{"type":"string"},"description":"Client-specific import API key. Must match the key used to start the import job, and\ninclude the imports.delete scope.\n"}],"responses":{"204":{"description":"Import job deleted successfully."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}},"patch":{"tags":["import"],"summary":"Patch an import job","description":"This endpoint can be used to stop an import job, given its jobId. This operation will prevent\nany further scraping of the import job URLs, and mark the job status as STOPPED. The results\nwill not be saved to storage, allowing the user to start a new import immediately.\n","operationId":"stopImportJob","security":[{"scoped_api_key":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ImportJobStopRequest"}}}}},"parameters":[{"$ref":"#/components/parameters/jobId"},{"in":"header","name":"x-api-key","schema":{"type":"string"},"description":"Client-specific import API key. Must match the key used to start the import job, and\ninclude the imports.write scope.\n"}],"responses":{"204":{"description":"Import job stopped successfully."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/tools/import/jobs/{jobId}/progress":{"get":{"tags":["import"],"summary":"Query the progress of an import job","description":"This endpoint can be used to query the progress of an import job, given its jobId.\n","operationId":"getImportJobProgress","security":[{"scoped_api_key":[]}],"parameters":[{"$ref":"#/components/parameters/jobId"},{"in":"header","name":"x-api-key","schema":{"type":"string"},"description":"Client-specific import API key. Must match the key used to start the import job.\n"}],"responses":{"200":{"description":"The current progress of the import job.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportJobProgress"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/tools/import/jobs/{jobId}/result":{"post":{"tags":["import"],"summary":"Request a pre-signed URL to download the result of an import job as a .zip archive","description":"This endpoint can be used to download an archive of an import job, which will include\nall the resulting documents that were generated as part of the import. It will also \ninclude the import-report.xlsx file, which contains a summary of the import job.\n","operationId":"getImportJobArchive","security":[{"scoped_api_key":[]}],"parameters":[{"$ref":"#/components/parameters/jobId"},{"in":"header","name":"x-api-key","schema":{"type":"string"},"description":"Client-specific import API key. Must match the key used to start the import job.\n"}],"responses":{"200":{"description":"Successful operation with an import archive delivered to the client.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportJobArchive"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/tools/import/assistant/prompt":{"post":{"tags":["import"],"summary":"Send a prompt to the import assistant","description":"Note: Not implemented yet.\n\nThis endpoint can be used to send prompts to the import assistant.\nEach prompt will make use of AI to analyze a URL and return\nchoices in response to the request.\n","operationId":"processImportAssistant","security":[{"scoped_api_key":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportAssistantRequest"}}}},"parameters":[{"in":"header","name":"x-api-key","schema":{"type":"string"},"description":"Client-specific import API key with the 'imports.assistant' scope.\n"}],"responses":{"200":{"description":"Contents of the response from the import AI assistant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportAssistantResponse"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}},"components":{"securitySchemes":{"api_key":{"type":"apiKey","in":"header","name":"x-api-key","description":"DEPRECATED, use scoped_api_key or ims_key. (Used for read-only operations.)"},"scoped_api_key":{"type":"apiKey","in":"header","name":"x-api-key","description":"For endpoints which authenticate with scoped API keys"},"ims_key":{"type":"apiKey","in":"header","name":"authorization","description":"Value must be a valid IMS user token which will be offline-validated."},"admin_key":{"type":"apiKey","in":"header","name":"x-api-key","description":"DEPRECATED, use scoped_api_key or ims_key. (Used for read and write operations.)"}},"schemas":{"AuditType":{"type":"string","enum":["404","apex","cwv","lhs","lhs-desktop","lhs-mobile","broken-backlinks","canonical","sitemap","structured-data","costs","meta-tags","broken-internal-links","experimentation-opportunities"],"example":"cwv"},"Id":{"type":"string","format":"uuid","readOnly":true,"example":"123e4567-e89b-12d3-a456-426614174000"},"DateTime":{"type":"string","format":"date-time","example":"2024-01-19T14:20:30Z"},"DeliveryType":{"type":"string","enum":["aem_edge","aem_cs","other"],"example":"aem_edge"},"ExperimentationOpportunity":{"type":"object","readOnly":true,"properties":{"type":{"type":"string","description":"Type of the experimentation opportunity","example":"generic"},"page":{"type":"string","description":"The title of the webpage","example":"Retirement Calculator"},"screenshot":{"type":"string","format":"url","description":"A URL pointing to the screenshot of the webpage.","example":"https://space.cat/screenshots/some-cool-page.png"},"trackedPageKPIName":{"type":"string","description":"The name of KPI tracked.","example":"Bounce rate"},"trackedPageKPIValue":{"type":"number","description":"The value of KPI tracked for this page.","example":0.8},"trackedKPISiteAverage":{"type":"number","description":"The average value of KPI tracked across the site.","example":0.45},"pageviews":{"type":"integer","description":"The total number of views this webpage has received","example":15000},"samples":{"type":"integer","description":"The total number of samples we have for this webpage in RUM","example":150},"activeExperiments":{"type":"string","description":"The number of active experiments on the webpage, or 'none' if there are no active experiments.","examples":["None","2 active"]},"metrics":{"type":"array","description":"The metrics for the experimentation opportunity","items":{"type":"object"}},"recommendations":{"type":"array","description":"The recommendations for the experimentation opportunity","items":{"type":"object"},"example":[{"type":"guidance","insight":"The main CTAs (\"Buy now\", \"Free trial\") are not prominently visible above the fold for users coming from platforms like TikTok.","recommendation":"Relocate one of the primary CTAs, such as \"Buy now\", to a more prominent position above the fold where it is immediately visible upon landing on the page."},{"type":"guidance","insight":"The current design and layout of the page, while visually appealing, might be overwhelming for users coming from TikTok who prefer short and concise content.","recommendation":"Simplify the page by reducing the amount of text and focusing on key features with visually engaging images or short videos, particularly near the top of the page."}]}}},"URL":{"type":"string","format":"url","example":"https://www.example.com"},"BrokenBacklink":{"type":"object","properties":{"url_to":{"description":"The URL of the broken link.","$ref":"#/components/schemas/URL"},"title":{"description":"The title of the page referring to the broken link.","type":"string"},"url_from":{"description":"The URL of the page referring to the broken link.","$ref":"#/components/schemas/URL"},"traffic_domain":{"description":"The referring domain's estimated monthly organic traffic from search.","type":"number"}}},"Priority":{"type":"string","enum":["high","medium","low"],"example":"high"},"BrokenInternalLink":{"type":"object","properties":{"urlTo":{"description":"The URL of the broken internal link.","$ref":"#/components/schemas/URL"},"title":{"description":"The title of the internal page referring to the broken internal link.","type":"string"},"urlFrom":{"description":"The URL of the internal page referring to the broken link.","$ref":"#/components/schemas/URL"},"trafficDomain":{"description":"The referring page's estimated monthly organic traffic.","type":"number"},"priority":{"description":"The priority of the broken internal link","$ref":"#/components/schemas/Priority"}}},"Verdict":{"type":"string","description":"High-level verdict about whether the URL is indexed.","enum":["VERDICT_UNSPECIFIED","PASS","PARTIAL","FAIL","NEUTRAL"]},"StructuredData":{"type":"object","readOnly":true,"properties":{"inspectionUrl":{"type":"string","description":"The URL that was inspected"},"indexStatusResult":{"type":"object","description":"Result of the index status analysis.","properties":{"verdict":{"$ref":"#/components/schemas/Verdict"},"lastCrawlTime":{"$ref":"#/components/schemas/DateTime"}}},"richResults":{"type":"object","description":"Result of the Rich Results analysis. Absent if there are no rich results found.","properties":{"verdict":{"$ref":"#/components/schemas/Verdict"},"detectedItemTypes":{"type":"array","description":"A list of zero or more rich result types detected on this page.","items":{"type":"string","example":"Product snippets"}},"detectedIssues":{"type":"array","description":"A list of zero or more rich results errors detected on this page.","items":{"type":"object","properties":{"richResultType":{"type":"string","description":"Rich Results type detected on this page.","example":"Product snippets"},"items":{"type":"array","description":"List of Rich Results items that have issues.","items":{"type":"object","properties":{"name":{"type":"string","description":"The user-provided name of this item.","example":"Product name"},"issues":{"type":"array","description":"A list of rich result issues found for this instance.","items":{"type":"object","properties":{"issueMessage":{"type":"string","description":"Rich Results issue type.","example":"Missing field \"image\""},"severity":{"type":"string","description":"Severity of this issue.","example":"ERROR"}}}}}}}}}}}}}},"CWVMetric":{"type":"object","properties":{"deviceType":{"type":"string","description":"The type of device","enum":["mobile","desktop"],"example":"mobile"},"pageviews":{"type":"integer","description":"Total pageviews for this device type","example":2120},"lcp":{"type":"number","format":"float","description":"Largest Contentful Paint (LCP) metric","example":2099.7},"lcpCount":{"type":"integer","description":"The count of LCP samples","example":9},"cls":{"type":"number","format":"float","description":"Cumulative Layout Shift (CLS) metric","example":0.02066},"clsCount":{"type":"integer","description":"The count of CLS samples","example":7},"inp":{"type":"integer","format":"float","description":"Interaction to Next Paint (INP) metric","example":12},"inpCount":{"type":"integer","description":"The count of INP samples","example":3},"ttfb":{"type":"number","format":"float","description":"Time to First Byte (TTFB) metric","example":520.45},"ttfbCount":{"type":"integer","description":"The count of TTFB samples","example":18}}},"AuditResult":{"description":"The result of an audit, which is dependent on the audit type.","oneOf":[{"type":"object","additionalProperties":true},{"type":"object","properties":{"experimentationOpportunities":{"type":"array","description":"A list of experimentation opportunities","items":{"$ref":"#/components/schemas/ExperimentationOpportunity"}}}},{"type":"object","description":"The result of broken-backlinks audit.\n","properties":{"brokenBacklinks":{"type":"array","description":"A list of broken backlinks.","items":{"$ref":"#/components/schemas/BrokenBacklink"}},"fullAuditRef":{"description":"A reference by which the full external result of an audit can be accessed, which is dependent on the audit type.\n","type":"string"}}},{"type":"object","description":"The result of broken-internal-links audit.\n","properties":{"brokenInternalLinks":{"type":"array","description":"A list of broken internal links.","items":{"$ref":"#/components/schemas/BrokenInternalLink"}},"fullAuditRef":{"description":"A reference by which the full external result of an audit can be accessed, which is dependent on the audit type.\n","type":"string"},"finalUrl":{"description":"The final URL for the audited page.","type":"string"}}},{"type":"array","description":"Information about the provided URLs in the Google index.","items":{"$ref":"#/components/schemas/StructuredData"}},{"type":"object","description":"The result of costs audit.\n","properties":{"ahrefs":{"type":"object","properties":{"usedApiUnits":{"description":"API units used so far in the current month.\n","type":"integer"},"limitApiUnits":{"description":"Limit of API units for the current month.\n","type":"integer"},"fullAuditRef":{"description":"A reference by which the full external result of an audit can be accessed, which is dependent on the audit type.\n","type":"string"}}}}},{"type":"object","description":"The result of a meta-tags audit.\n","properties":{"auditResult":{"type":"object","properties":{"detectedTags":{"description":"A mapping of URLs to their detected meta-tags issues and recommendations.\n","type":"object","additionalProperties":{"type":"object","properties":{"title":{"type":"object","properties":{"seoRecommendation":{"description":"SEO recommendation for the title tag.\n","type":"string"},"issue":{"description":"The issue detected in the title tag.\n","type":"string"},"issueDetails":{"description":"Detailed explanation of the issue detected in the title tag.\n","type":"string"},"seoImpact":{"description":"The impact of the detected issue on SEO.\n","type":"string"}}}}}},"finalUrl":{"description":"The final URL for the audited page.\n","type":"string"}}}}},{"type":"object","description":"The result of CWV audit","properties":{"cwv":{"type":"array","description":"A list of CWV metrics per device type","items":{"type":"object","properties":{"type":{"type":"string","enum":["group","url"],"description":"Specifies if the metric applies to a 'group' or an individual 'url'"},"name":{"type":"string","description":"Name of the group (only applicable when type is 'group')","example":"Homepage Group"},"pattern":{"type":"string","description":"URL pattern for the group (only applicable when type is 'group')","example":"https://www.aem.live/home*"},"url":{"description":"URL of the page (only applicable when type is 'url')","$ref":"#/components/schemas/URL"},"pageviews":{"type":"integer","description":"Total pageviews for this group or URL","example":4620},"organic":{"type":"integer","description":"Total organic traffic for this group or URL","example":2510},"metrics":{"type":"array","description":"Array of performance metrics by device type","items":{"$ref":"#/components/schemas/CWVMetric"}}}}}}}]},"Audit":{"type":"object","readOnly":true,"properties":{"siteId":{"description":"The ID of the site this audit belongs to","$ref":"#/components/schemas/Id"},"auditedAt":{"description":"The date and time of the audit in ISO 8601 format","$ref":"#/components/schemas/DateTime"},"expiresAt":{"description":"The date and time when the audit expires in ISO 8601 format","$ref":"#/components/schemas/DateTime"},"deliveryType":{"description":"The type of the delivery this site is using","$ref":"#/components/schemas/DeliveryType"},"fullAuditRef":{"description":"A reference by which the full external result of an audit can be accessed, which is dependent on the audit type.\n","type":"string"},"auditResult":{"$ref":"#/components/schemas/AuditResult"},"previousAuditResult":{"$ref":"#/components/schemas/AuditResult"}},"example":{"siteId":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","auditedAt":"2024-01-20T12:00:00Z","expiresAt":"2024-07-20T12:00:00Z","auditType":"cwv","isError":false,"deliveryType":"aem_edge","fullAuditRef":"https://some-audit-system/full-report/1234","auditResult":{"someProperty":"someValue"},"previousAuditResult":{"someProperty":"somePreviousValue"}}},"AuditList":{"type":"array","items":{"$ref":"#/components/schemas/Audit"}},"Job":{"type":"object","properties":{"group":{"type":"string","description":"The group or category to which the job belongs, helping in organizing jobs by their functional area."},"interval":{"type":"string","description":"Specifies how often the job should run, e.g., 'daily'. This is part of job scheduling information."},"type":{"type":"string","description":"The job type, indicating the specific action or task that the job performs, such as 'rum-to-aa' indicating a data import job from RUM to AA."}}},"Configuration":{"type":"object","properties":{"version":{"type":"string","readOnly":true,"description":"Internal version of the configuration, managed and incremented by the system. Not exposed for external control via the API."},"jobs":{"type":"array","items":{"$ref":"#/components/schemas/Job"},"description":"A list of job configurations, detailing job type, its group, and execution interval."},"queues":{"type":"object","properties":{"audits":{"type":"string","format":"url","description":"The SQS queue name for audit jobs"},"imports":{"type":"string","format":"url","description":"The SQS queue name for import jobs"},"reports":{"type":"string","format":"url","description":"The SQS queue name for report jobs"}}}}},"ConfigurationSitesAuditsUpdateResult":{"type":"object","properties":{"status":{"type":"integer","description":"The HTTP status code of the operation (e.g., 200 for success)"},"message":{"type":"string","description":"A message indicating the result of the operation"}},"required":["status","message"]},"HoolihanHeaders":{"type":"object","properties":{"x-request-id":{"description":"The request ID","type":"array","items":{"$ref":"#/components/schemas/Id"}},"miso-trace-id":{"description":"The Miso trace ID","type":"array","items":{"type":"string"}},"com-adobe-hoolihan-source-partition":{"description":"The source partition","type":"array","items":{"type":"string"}},"com-adobe-hoolihan-source-offset":{"description":"The source offset","type":"array","items":{"type":"string"}},"com-adobe-hoolihan-publish-time":{"description":"The time the event was published in milliseconds since the Unix Epoch","type":"array","items":{"type":"string","example":"1705914000000"}},"x-api-key":{"description":"The API key of the client which published the original event","type":"array","items":{"type":"string"}},"com-adobe-hoolihan-publisher":{"description":"The publisher of the original event","type":"array","items":{"type":"string"}},"com-adobe-hoolihan-source-topic":{"description":"The topic that the original event was published to","type":"array","items":{"type":"string"}},"com-adobe-hoolihan-on-behalf-of":{"description":"The client ID(s) that the event was forwarded on behalf of","type":"array","items":{"type":"string"}},"Content-Type":{"description":"The content type of the event value","type":"array","items":{"type":"string","example":"application/json"}}}},"HoolihanEventValue":{"type":"object","required":["content","headers"],"properties":{"content":{"description":"The JSON payload of the event, encoded as a Base64 string","type":"string"},"headers":{"description":"Metadata headers included by Hoolihan on each event","$ref":"#/components/schemas/HoolihanHeaders"}}},"HoolihanEvent":{"type":"object","required":["id","topic","value","partition","offset"],"properties":{"id":{"description":"The Hoolihan ID of the event","type":"string"},"topic":{"description":"The name of the Hoolihan topic that the event was received on","type":"string"},"value":{"description":"Value of the event, which contains the message payload from the publishing system","$ref":"#/components/schemas/HoolihanEventValue"},"partition":{"description":"The partition index that the event was received on","type":"integer"},"offset":{"description":"The offset of the event within the partition","type":"integer"}},"example":{"id":"b7fyJDj1bu5yrt82RxLX89a98a73KSqR4ptC5MRvlEoLshbgAB3emGKdjQleAMyINZcoAkM6cB7ma2aV","topic":"example_fulfillment_topic","partition":0,"offset":1234,"value":{"content":"ewogICAgImV4dGVybmFsX3JlcXVlc3RfaWQiOiAiMTIzNDUiLAogICAgInJlcXVlc3Rvcl9pZCI6ICIxMjM0NTY3ODkw\nQUJDREVGMTIzNDU2NzhAYWRvYmUuY29tIiwKICAgICJvd25lcl9pZCI6ICIxMjM0NTY3ODkwQUJDREVGMTIzNDU2NzhA\nQWRvYmVPcmciLAogICAgInJlcXVlc3RfdHlwZSI6ICJSRUdVTEFSIiwKICAgICJyZXF1ZXN0b3Jfc3lzdGVtIjogIkFB\nVUkiLAogICAgImZ1bGZpbGxtZW50X2lkIjogIjEyMzQ1Njc4OTBhYmNkZWYxMjM0NTY3ODkwYWJjZGVmMTIzNDU2Nzg5\nMGFiY2RlZjEyMzQ1Njc4OTBhYmNkZWYiLAogICAgImNyZWF0ZV9kYXRlIjogIjIwMjQtMDEtMjJUMDk6MjA6MDEuMTIz\nNDVaIiwKICAgICJpdGVtcyI6IFsKICAgICAgICB7CiAgICAgICAgICAgICJleHRlcm5hbF9pdGVtX2lkIjogIjEyMzQ1\nLWFiY2QtMTIzNC0xMjM0LTEyMzQ0MzIxIiwKICAgICAgICAgICAgInF1YW50aXR5IjogIlVOTElNSVRFRCIsCiAgICAg\nICAgICAgICJvZmZlcl9pZCI6ICIxMjM0NTY3ODkwQUJDREVGMTIzNDU2Nzg5MEFCQ0RFRiIsCiAgICAgICAgICAgICJh\nY2NlcHRlZF90ZXJtcyI6IHsKICAgICAgICAgICAgICAgICJjb250cmFjdF9pZCI6ICIxMjM0NTY3ODkwQUJDREVGMTIz\nNCIsCiAgICAgICAgICAgICAgICAiYWNjZXB0ZWRfYWdyZWVtZW50IjogIklOSVRJQUwiCiAgICAgICAgICAgIH0sCiAg\nICAgICAgICAgICJmdWxmaWxsYWJsZV9pdGVtc19jb21wbGV0ZWQiOiBbCiAgICAgICAgICAgICAgICB7CiAgICAgICAg\nICAgICAgICAgICAgImlkIjogIjEyM2U0NTY3LWU4OWItMTJkMy1hNDU2LTQyNjYxNDE3NDAwMCIsCiAgICAgICAgICAg\nICAgICAgICAgImNvZGUiOiAiZHhfZXhhbXBsZV9zb2x1dGlvbiIsCiAgICAgICAgICAgICAgICAgICAgImZ1bGZpbGxt\nZW50X2RldGFpbHMiOiB7CiAgICAgICAgICAgICAgICAgICAgICAgICJmdWxmaWxsYWJsZV9lbnRpdHlfcmVzb3VyY2Vf\nbG9jYXRvciI6ICJodHRwczovL2V4YW1wbGUuY29tLzEyMzQ1Njc4OTBBQkNERUYxMjM0NTY3OEBBZG9iZU9yZyIsCiAg\nICAgICAgICAgICAgICAgICAgICAgICJmdWxmaWxsYWJsZV9lbnRpdHlfcmVzb3VyY2VfbmFtZSI6ICJFeGFtcGxlIFNv\nbHV0aW9uIgogICAgICAgICAgICAgICAgICAgIH0KICAgICAgICAgICAgICAgIH0KICAgICAgICAgICAgXQogICAgICAg\nIH0KICAgIF0KfQ==","headers":{"x-request-id":["123e4567-e89b-12d3-a456-426614174000"],"miso-trace-id":["12345678abcdef12:12345678abcdef12:12345678abcdef12:1"],"com-adobe-hoolihan-source-partition":["0"],"com-adobe-hoolihan-source-offset":["1234"],"com-adobe-hoolihan-publish-time":["1705915000000"],"x-api-key":["example_publisher_client_id"],"com-adobe-hoolihan-publisher":["example_publisher_client_id"],"com-adobe-hoolihan-source-topic":["example_source_topic"],"com-adobe-hoolihan-on-behalf-of":["example_other_client_id"],"Content-Type":["application/json"]}}}},"HoolihanEvents":{"type":"array","items":{"$ref":"#/components/schemas/HoolihanEvent"}},"ProcessingStatus":{"type":"string","enum":["accepted","rejected"],"example":"accepted"},"FulfillmentProcessingResults":{"type":"array","items":{"type":"object","required":["status"],"properties":{"status":{"description":"The acceptance status (whether or not the event was accepted for processing)","$ref":"#/components/schemas/ProcessingStatus"},"requestId":{"description":"The request ID","$ref":"#/components/schemas/Id"}}},"example":[{"status":"accepted","requestId":"123e4567-e89b-12d3-a456-426614174000"},{"status":"rejected"}]},"CDNXForwardedHostAlert":{"type":"object","additionalProperties":true,"properties":{"forwardedHost":{"description":"value of x-forwarded-host header in the CDN log which trggered the domain discovery alert","type":"string","example":"blog.adobe.com, main--blog--adobecom.hlx.live, main--blog--adobecom.hlx.live, main--blog--adobecom.hlx-fastly.page"}}},"Domain":{"type":"string","format":"domain","example":"www.example.com"},"RUMDomainDiscoveryAlert":{"type":"object","additionalProperties":true,"properties":{"url":{"description":"URL of the page which triggered the domain discovery alert","$ref":"#/components/schemas/URL"},"domain":{"description":"Domain of the page which triggered the domain discovery alert","$ref":"#/components/schemas/Domain"}}},"AnalyticsSiteIntegration":{"type":"object","additionalProperties":true,"required":["siteId","reporting","dataCollection","dataStore","dataMapping"],"properties":{"siteId":{"description":"The site ID in uuid format","$ref":"#/components/schemas/Id"},"reporting":{"description":"The reporting details","type":"object","required":["link"],"additionalProperties":true,"properties":{"link":{"description":"The link to the report in the reporting tool.\nFor Adobe Analytics and Customer Journey Analytics, the link to the Analysis Workspace report.\n","$ref":"#/components/schemas/URL"},"timezone":{"description":"The timezone for the data in the report","type":"string"}}},"dataCollection":{"description":"The configuration for the data collection to embed on the site.","type":"object","required":["type","environments"],"properties":{"type":{"description":"The type of the data collection","type":"string","enum":["adobe-tags","aep-websdk"]},"environments":{"description":"The environments for the data collection script.\nAt least the script for the production environment is required.\nThe keys represent the environments (development, staging, production).\nThe values represent the URL or ID of the data collection script.\nFor Adobe Analytics and Customer Journey Analytics, the values are either\nURL for the Adobe Launch script or the datastream ID.\n","type":"object","additionalProperties":{"type":"string"},"required":["production"],"properties":{"production":{"description":"The URL or ID of the production data collection script","type":"string"}}}}},"dataStore":{"description":"The data store details","type":"object","required":["id","type"],"additionalProperties":true,"properties":{"id":{"description":"The ID of the data store","type":"string"},"type":{"description":"The type of the data store","type":"string","enum":["adobe-analytics","aep"]}}},"dataSchema":{"description":"The data schema details","type":"object","required":["id"],"additionalProperties":true,"properties":{"id":{"description":"The ID of the data schema","type":"string"}}},"dataMapping":{"description":"The data mapping details","type":"object","required":["type","mappings"],"properties":{"type":{"description":"The type of the data mapping","type":"string","enum":["adobe-analytics","xdm"]},"mappings":{"description":"The data mapping details. The keys represent human-friendly naming of metrics and dimensions captured by the\ninstrumentation of the site. The values represent the corresponding metric and dimension names in the data store.\nFor Adobe Analytics, the values are either evars or events.\nFor XDM, the values are the paths in the data schema.\n","type":"object","additionalProperties":{"type":"string"}}}}},"examples":[{"analytics-site-integration-aa-tags":{"$ref":"./examples.yaml#/analytics-site-integration-aa-tags"}},{"analytics-site-integration-aa-aep-websdk":{"$ref":"./examples.yaml#/analytics-site-integration-aa-aep-websdk"}},{"analytics-site-integration-cja-tags":{"$ref":"./examples.yaml#/analytics-site-integration-cja-tags"}},{"analytics-site-integration-cja-websdk":{"$ref":"./examples.yaml#/analytics-site-integration-cja-websdk"}}]},"ImsOrganizationId":{"type":"string","example":"1234567890ABCDEF12345678@AdobeOrg"},"SlackConfig":{"type":"object","additionalProperties":true,"properties":{"channel":{"description":"The Slack channel ID to send notifications to","type":"string","example":"C1234567890"},"workspace":{"description":"The Slack workspace name to send notifications to","type":"string","example":"example-workspace"},"invitedUserCount":{"description":"The number of external users invited to the Slack channel","type":"integer","example":5},"channel-url":{"description":"Slack URL of the channel to send notifications to","type":"string","example":"https://example-workspace.slack.com/archives/C1234567890"}}},"SlackMentionConfig":{"type":"object","properties":{"slack":{"type":"array","items":{"type":"string"}}}},"HandlerConfig":{"type":"object","additionalProperties":false,"properties":{"mentions":{"$ref":"#/components/schemas/SlackMentionConfig"},"excludedURLs":{"description":"URLs to be excluded from the handler's processing","type":"array","items":{"type":"string","format":"uri"}},"groupedURLs":{"description":"List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed","type":"array","items":{"type":"object","properties":{"name":{"description":"Name of the URL group","type":"string"},"pattern":{"description":"Pattern representing the URL path structure to group","type":"string"}}}}},"patternProperties":{"^(404|broken-backlinks)$":{"type":"object","properties":{"mentions":{"$ref":"#/components/schemas/SlackMentionConfig"}}}},"example":{"excludedURLs":["https://www.adobe.com/excluded-page","https://www.adobe.com/another-excluded-page"],"groupedURLs":[{"name":"catalog","pattern":"/products/"},{"name":"blog","pattern":"/post/"}]}},"Config":{"type":"object","additionalProperties":true,"properties":{"slack":{"description":"Optional. The Slack configuration","$ref":"#/components/schemas/SlackConfig"},"handlers":{"description":"Optional. The Alert configuration","$ref":"#/components/schemas/HandlerConfig"}}},"OrganizationConfig":{"allOf":[{"$ref":"#/components/schemas/Config"}]},"Organization":{"type":"object","properties":{"id":{"description":"The organization ID in uuid format","$ref":"#/components/schemas/Id"},"name":{"description":"The name of the organization","type":"string"},"imsOrgId":{"description":"Optional. The ID of the Adobe IMS organization","$ref":"#/components/schemas/ImsOrganizationId"},"config":{"description":"Optional. The configuration of the organization","$ref":"#/components/schemas/OrganizationConfig"},"createdAt":{"description":"The date and time when the organization was created","$ref":"#/components/schemas/DateTime"},"updatedAt":{"description":"The date and time when the organization was last updated","$ref":"#/components/schemas/DateTime"}},"example":{"id":"o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z","name":"Example Organization","imsOrgId":"1234567890ABCDEF12345678@AdobeOrg","config":{"slack":{"channel":"#example-channel","workspace":"example-workspace","invitedUserCount":5},"handlers":{"404":{"byOrg":true,"mentions":{"slack":["@user1","@user2"]}},"cwv":{"byOrg":false,"mentions":{"slack":["@user5","@user6"]}}}},"createdAt":"2023-12-15T09:30:00Z","updatedAt":"2024-01-19T11:20:00Z"}},"OrganizationList":{"type":"array","items":{"$ref":"#/components/schemas/Organization"}},"OrganizationCreate":{"type":"object","required":["name"],"properties":{"name":{"description":"The name of the organization","type":"string"},"imsOrgId":{"description":"Optional. The ID of the Adobe IMS organization","$ref":"#/components/schemas/ImsOrganizationId"},"config":{"description":"Optional. The configuration of the organization","$ref":"#/components/schemas/OrganizationConfig"}},"example":{"name":"Example Organization","imsOrgId":"1234567890ABCDEF12345678@AdobeOrg","config":{"slack":{"channel":"#example-channel","workspace":"example-workspace"},"handlers":{"404":{"mentions":{"slack":["@user3","@user4"]}},"cwv":{"byOrg":false,"mentions":{"slack":["@user5","@user6"]}}}}}},"OrganizationUpdate":{"type":"object","properties":{"name":{"description":"The name of the organization","type":"string"},"imsOrgId":{"description":"Optional. The ID of the Adobe IMS organization","$ref":"#/components/schemas/ImsOrganizationId"},"config":{"description":"Optional. The configuration of the organization","$ref":"#/components/schemas/OrganizationConfig"}},"example":{"name":"Example Organization","imsOrgId":"1234567890ABCDEF12345678@AdobeOrg","config":{"slack":{"channel":"#example-channel","workspace":"example-workspace","handlers":{"404":{"mentions":{"slack":["@user3","@user4"]}},"cwv":{"mentions":{"slack":["@user5","@user6"]}}}}}}},"SiteConfig":{"allOf":[{"$ref":"#/components/schemas/Config"}]},"Site":{"type":"object","properties":{"id":{"description":"The site ID in uuid format","$ref":"#/components/schemas/Id"},"organizationId":{"description":"The optional ID of the organization this site belongs to","$ref":"#/components/schemas/Id"},"baseURL":{"description":"The base URL of the site","$ref":"#/components/schemas/URL"},"deliveryType":{"description":"The type of the delivery this site is using","$ref":"#/components/schemas/DeliveryType"},"gitHubURL":{"description":"The optional GitHub URL of the site","$ref":"#/components/schemas/URL"},"goLiveDate":{"description":"The date and time when the site went live on AEM Edge","nullable":true,"$ref":"#/components/schemas/DateTime"},"config":{"description":"Optional. The configuration of the site. May override the organization configuration.","$ref":"#/components/schemas/SiteConfig"},"createdAt":{"description":"The date and time when the site was created","$ref":"#/components/schemas/DateTime"},"updatedAt":{"description":"The date and time when the site was last updated","$ref":"#/components/schemas/DateTime"}},"example":{"id":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","organizationId":"o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z","baseURL":"https://example-site.com","deliveryType":"aem_edge","gitHubURL":"https://github.com/example/repo","goLiveDate":"2024-01-20T10:00:00Z","config":{"slack":{"channel":"C1234567890","workspace":"example-workspace"},"handlers":{"404":{"mentions":{"slack":["@user1","@user2"]}},"broken-backlinks":{"mentions":{"slack":["@user5","@user6"]},"excludedURLs":{"description":"URLs to be excluded from the alert","type":"array","items":{"type":"string","format":"uri'"}},"groupedURLs":{"description":"List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed","type":"array","items":{"type":"object","properties":{"name":{"description":"Name of the URL group","type":"string"},"pattern":{"description":"Pattern representing the URL path structure to group","type":"string"}}}}}}},"createdAt":"2023-12-15T09:30:00Z","updatedAt":"2024-01-19T11:20:00Z"}},"SiteList":{"type":"array","items":{"$ref":"#/components/schemas/Site"}},"ImportOptions":{"type":"object","properties":{"pageLoadTimeout":{"description":"The time in milliseconds to wait for the page to load","type":"integer"},"enableJavascript":{"description":"Whether to enable JavaScript on the page","type":"boolean"}},"example":{"pageLoadTimeout":100,"enableJavascript":true}},"ScrapeRequest":{"type":"object","required":["urls"],"properties":{"jobId":{"description":"Optional ID of the scrape job","$ref":"#/components/schemas/Id"},"options":{"description":"Optional configuration params, defined as a JSON object","$ref":"#/components/schemas/ImportOptions"},"customHeaders":{"description":"Optional custom headers to send with each HTTP request","type":"object"},"urls":{"description":"The URLs to scrape. The URLs must be unique. Limit of 10 URLs per request.","type":"array","items":{"type":"object","properties":{"url":{"description":"The URL to scrape","$ref":"#/components/schemas/URL"}}},"example":{"urls":[{"url":"https://example.com/en/page1"},{"url":"https://example.com/fr/page2"}]}}}},"ScrapeResult":{"type":"array","items":{"type":"object","properties":{"url":{"description":"The URL of the scraped page","$ref":"#/components/schemas/URL"},"status":{"description":"The status of the scrape job","type":"string","enum":["COMPLETE","FAILED"]},"content":{"description":"The content of the scraped page","type":"string"},"error":{"description":"The error message if the scrape failed","type":"string"}},"example":[{"url":"https://example.com/en/page1","status":"COMPLETE","content":"<body>...</body>"},{"url":"https://example.com/fr/page2","status":"FAILED","error":"Timeout"}]}},"ScrapeResponse":{"type":"object","properties":{"id":{"description":"The ID of the scrape job","$ref":"#/components/schemas/Id"},"status":{"description":"The status of the scrape job","type":"string","enum":["COMPLETE","FAILED"]},"startTime":{"description":"The date and time when the scrape job started","$ref":"#/components/schemas/DateTime"},"endTime":{"description":"The date and time when the scrape job ended, if finished","$ref":"#/components/schemas/DateTime"},"urlCount":{"description":"The total number of URLs in the job","type":"integer"},"successCount":{"description":"The number of URLs successfully scraped","type":"integer"},"failedCount":{"description":"The number of URLs that failed to scrape","type":"integer"},"results":{"description":"The scrape results","type":"array","items":{"$ref":"#/components/schemas/ScrapeResult"}}},"example":{"id":"12d6ac8e-d5e4-4788-90eb-b69e10e745fd","status":"COMPLETE","startTime":"2024-01-19T14:20:30Z","urlCount":10,"successCount":9,"failedCount":1,"results":[{"url":"https://example.com/en/page1","status":"COMPLETE","content":"..."},{"url":"https://example.com/fr/page2","status":"FAILED","error":"..."}]}},"SiteCreate":{"type":"object","required":["baseURL","deliveryType"],"properties":{"organizationId":{"description":"The optional ID of the organization this site belongs to","default":null,"$ref":"#/components/schemas/Id"},"baseURL":{"description":"The base URL of the site","$ref":"#/components/schemas/URL"},"deliveryType":{"description":"The type of the delivery this site is using","$ref":"#/components/schemas/DeliveryType"},"gitHubURL":{"description":"The optional GitHub URL of the site","$ref":"#/components/schemas/URL"},"goLiveDate":{"description":"The date and time when the site went live on AEM Edge","nullable":true,"$ref":"#/components/schemas/DateTime"}},"example":{"organizationId":"o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z","baseURL":"https://www.newsite.com","deliveryType":"aem_cs"}},"SiteWithLatestAudit":{"allOf":[{"$ref":"#/components/schemas/Site"},{"type":"object","properties":{"audits":{"description":"An array with the latest audit for the given audit type","type":"array","items":{"$ref":"#/components/schemas/Audit"}}}}],"example":{"id":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","organizationId":"o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z","baseURL":"https://example-site.com","deliveryType":"aem_edge","gitHubURL":"https://github.com/example/repo","goLiveDate":"2024-01-20T10:00:00Z","createdAt":"2023-12-15T09:30:00Z","updatedAt":"2024-01-19T11:20:00Z","audits":[{"siteId":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","auditedAt":"2024-01-20T12:00:00Z","expiresAt":"2024-07-20T12:00:00Z","auditType":"cwv","isError":false,"deliveryType":"aem_edge","fullAuditRef":"https://some-audit-system/full-report/1234","auditResult":{"someProperty":"someValue"},"previousAuditResult":{"someProperty":"somePreviousValue"}}]}},"SiteWithLatestAuditList":{"type":"array","items":{"$ref":"#/components/schemas/SiteWithLatestAudit"}},"SiteUpdate":{"type":"object","properties":{"organizationId":{"description":"The optional ID of the organization this site belongs to","$ref":"#/components/schemas/Id"},"deliveryType":{"description":"The type of the delivery this site is using","$ref":"#/components/schemas/DeliveryType"},"goLiveDate":{"description":"The date and time when the site went live on AEM Edge","nullable":true,"$ref":"#/components/schemas/DateTime"},"config":{"description":"Optional. The configuration of the site","$ref":"#/components/schemas/SiteConfig"}},"example":{"organizationId":"u7y6t5r4-e3w2-x1z0-z9y8-x7v6w5u4t3s2","deliveryType":"other","goLiveDate":"2024-01-20T10:00:00Z"}},"UpdateHandlerTypeConfig":{"type":"object","properties":{"excludedURLs":{"description":"Set of URLs to exclude. If empty, previously excluded URLs will be removed","type":"array","items":{"type":"string"}},"groupedURLs":{"description":"List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed","type":"array","items":{"type":"object","properties":{"name":{"description":"Name of the URL group","type":"string"},"pattern":{"description":"Pattern representing the URL path structure to group","type":"string"}}}}},"example":{"excludedURLs":["https://www.adobe.com/some-page","https://www.adobe.com/another-page"],"groupedURLs":[{"name":"catalog","pattern":"/products/"},{"name":"blog","pattern":"/post/"}]}},"OpportunityType":{"description":"Type of opportunity","type":"string","enum":["broken-backlinks","broken-internal-links"],"example":"broken-backlinks"},"BrokenBacklinksOpportunityData":{"description":"Data specific to broken backlinks opportunity","type":"object","additionalProperties":true},"BrokenInternalLinksOpportunityData":{"description":"Data specific to broken internal links opportunity","type":"object","properties":{"projectedTrafficLost":{"type":"number","description":"Projected Traffic Lost, representing the estimated loss of organic traffic"},"projectedTrafficValue":{"type":"number","description":"Projected Traffic Value, calculated by multiplying the Projected Traffic Lost by the Cost Per Click (CPC) value."}},"additionalProperties":true},"CWVOpportunityData":{"description":"Data specific to Core Web Vitals improvements opportunity","type":"object","properties":{"projectedTrafficLost":{"type":"number","description":"Projected Traffic Lost, representing the estimated loss of organic traffic"},"projectedTrafficValue":{"type":"number","description":"Projected Traffic Value, calculated by multiplying the Projected Traffic Lost by the Cost Per Click (CPC) value."}},"additionalProperties":true},"OpportunityOrigin":{"description":"Origin of opportunity.\n- AUTOMATION: generated by automation\n- ESS_OPS: generated manually by Experience Success Engineers\n- AI: generated by AI\n","type":"string","enum":["AUTOMATION","ESS_OPS","AI"],"example":"ESS_OPS"},"OpportunityStatus":{"description":"Status of an opportunity","type":"string","enum":["NEW","IN_PROGRESS","IGNORED","RESOLVED"],"example":"IN_PROGRESS"},"BrokenBacklinksGuidance":{"description":"Guidance specific to broken backlinks opportunity","type":"object","additionalProperties":true,"properties":{"steps":{"description":"The steps to resolve the broken backlinks opportunity","type":"array","items":{"type":"string"}}}},"BrokenInternalLinksGuidance":{"description":"Guidance specific to broken internal links opportunity","type":"object","additionalProperties":true,"properties":{"steps":{"description":"The steps to resolve the broken internal links opportunity","type":"array","items":{"type":"string"}}}},"CWVGuidance":{"description":"Guidance specific to Core Web Vitals improvements opportunity","type":"object","additionalProperties":true,"properties":{"steps":{"description":"The recommended steps to resolve Core Web Vitals issues and improve site performance.","type":"array","items":{"type":"string"}}}},"Opportunity":{"type":"object","properties":{"id":{"description":"UUID of this opportunity","$ref":"#/components/schemas/Id"},"siteId":{"description":"UUID of the site this opportunity is for","$ref":"#/components/schemas/Id"},"auditId":{"description":"UUID of the audit result that triggered this opportunity","$ref":"#/components/schemas/Id"},"runbook":{"description":"URL to the runbook for this opportunity","type":"string","format":"url","example":"https://example.com/runbook/broken-backlinks"},"type":{"$ref":"#/components/schemas/OpportunityType"},"data":{"description":"Optional map of type-specific data relevant to this opportunity","type":"object","additionalProperties":true,"oneOf":[{"$ref":"#/components/schemas/BrokenBacklinksOpportunityData"},{"$ref":"#/components/schemas/BrokenInternalLinksOpportunityData"},{"$ref":"#/components/schemas/CWVOpportunityData"}]},"origin":{"$ref":"#/components/schemas/OpportunityOrigin"},"title":{"description":"Title of this opportunity","type":"string","example":"Authoritative domains are linking to invalid SecurBank URLs. This could impact your SEO."},"description":{"description":"Description of this opportunity","type":"string","example":"Provide the correct target URL that each of the broken backlinks should be redirected to."},"status":{"description":"Status of this opportunity","$ref":"#/components/schemas/OpportunityStatus"},"guidance":{"description":"Guidance text specific to this opportunity","type":"object","additionalProperties":true,"oneOf":[{"$ref":"#/components/schemas/BrokenBacklinksGuidance"},{"$ref":"#/components/schemas/BrokenInternalLinksGuidance"},{"$ref":"#/components/schemas/CWVGuidance"}]},"tags":{"type":"array","items":{"type":"string"},"description":"Optional list of tags","example":["Traffic acquisition"]},"createdAt":{"description":"UTC timestamp of when the opportunity was created","$ref":"#/components/schemas/DateTime"},"updatedAt":{"description":"UTC timestamp of when the opportunity was last updated","$ref":"#/components/schemas/DateTime"}},"required":["id","siteId","auditId","runbook","type","origin","title","status","createdAt","updatedAt"]},"OpportunityList":{"type":"array","items":{"$ref":"#/components/schemas/Opportunity"}},"OpportunityCreate":{"type":"object","properties":{"auditId":{"description":"UUID of the audit result that triggered this opportunity","readOnly":false,"$ref":"#/components/schemas/Id"},"runbook":{"description":"URL to the runbook for this opportunity","type":"string","format":"url","example":"https://example.com/runbook/broken-backlinks"},"type":{"$ref":"#/components/schemas/OpportunityType"},"data":{"description":"Optional map of type-specific data relevant to this opportunity","type":"object","additionalProperties":true,"oneOf":[{"$ref":"#/components/schemas/BrokenBacklinksOpportunityData"},{"$ref":"#/components/schemas/BrokenInternalLinksOpportunityData"}]},"origin":{"description":"Origin of opportunity","$ref":"#/components/schemas/OpportunityOrigin"},"title":{"description":"Title of this opportunity","type":"string","example":"Authoritative domains are linking to invalid SecurBank URLs. This could impact your SEO."},"description":{"description":"Description of this opportunity","type":"string","example":"Provide the correct target URL that each of the broken backlinks should be redirected to."},"guidance":{"description":"Guidance text specific to this opportunity","type":"object","additionalProperties":true,"oneOf":[{"$ref":"#/components/schemas/BrokenBacklinksGuidance"},{"$ref":"#/components/schemas/BrokenInternalLinksGuidance"}]},"tags":{"type":"array","items":{"type":"string"},"description":"Optional list of tags","example":["Traffic acquisition"]}},"required":["auditId","runbook","type","origin","title"]},"OpportunityUpdate":{"type":"object","properties":{"runbook":{"description":"URL to the runbook for this opportunity","type":"string","format":"url","example":"https://example.com/runbook/broken-backlinks"},"data":{"description":"Optional map of type-specific data relevant to this opportunity","type":"object","additionalProperties":true,"oneOf":[{"$ref":"#/components/schemas/BrokenBacklinksOpportunityData"},{"$ref":"#/components/schemas/BrokenInternalLinksOpportunityData"}]},"title":{"description":"Title of this opportunity","type":"string","example":"Authoritative domains are linking to invalid SecurBank URLs. This could impact your SEO."},"description":{"description":"Description of this opportunity","type":"string","example":"Provide the correct target URL that each of the broken backlinks should be redirected to."},"status":{"description":"Status of this opportunity","$ref":"#/components/schemas/OpportunityStatus"},"guidance":{"description":"Guidance text specific to this opportunity","type":"object","additionalProperties":true,"oneOf":[{"$ref":"#/components/schemas/BrokenBacklinksGuidance"},{"$ref":"#/components/schemas/BrokenInternalLinksGuidance"}]},"tags":{"type":"array","items":{"type":"string"},"description":"Optional list of tags","example":["Traffic acquisition"]}}},"SuggestionType":{"description":"Type of suggestion:\n- REDIRECT_UPDATE: Add or update a redirect as suggested\n- EXPERIMENT: Run the experiment with the given suggestions\n- CONTENT_UPDATE: Update the content to the suggested\n- METADATA_UPDATE: Update the metadata to the suggested\n","type":"string","enum":["REDIRECT_UPDATE","EXPERIMENT","CONTENT_UPDATE","METADATA_UPDATE"],"example":"REDIRECT_UPDATE"},"BrokenBacklinksRedirectData":{"description":"Data specific to redirect suggestion for broken backlinks opportunity","type":"object","additionalProperties":true,"properties":{"title":{"description":"The title of the referring page","type":"string"},"url_from":{"description":"The URL of the referring page","type":"string"},"url_to":{"description":"The URL of the broken target page","type":"string"},"urls_suggested":{"description":"The proposed target URLs to redirect the broken backlink to","type":"array","items":{"type":"string"}},"manualOverrideURL":{"description":"The URL to manually override the proposed target URL","type":"string"},"traffic_domain":{"description":"The estimated monthly organic traffic to the referring page","type":"number"}}},"BrokenInternalLinksSuggestionData":{"description":"Data specific to redirect suggestion for broken internal links opportunity","type":"object","additionalProperties":true,"properties":{"title":{"description":"The title of the referring page","type":"string"},"urlFrom":{"description":"The URL of the referring page","type":"string"},"urlTo":{"description":"The URL of the broken target page","type":"string"},"aiRationale":{"description":"The rationale for the suggested fix","type":"string"},"urlsSuggested":{"description":"The proposed internal target URLs to point the broken internal link to","type":"array","items":{"type":"string"}},"manualOverrideURL":{"description":"The URL to manually override the proposed target URL","type":"string"},"trafficDomain":{"description":"The estimated monthly organic traffic to the referring page","type":"number"},"priority":{"description":"The priority of the broken internal link","$ref":"#/components/schemas/Priority"}}},"BrokenBacklinksKpiDeltas":{"description":"KPI deltas specific to redirect suggestion for broken backlinks opportunity","type":"object","additionalProperties":true},"BrokenInternalLinksKpiDeltas":{"description":"KPI deltas specific to redirect suggestion for broken internal links opportunity","type":"object","additionalProperties":true},"SuggestionStatus":{"description":"Status of this suggestion; status reflects overall fix execution, flagged here for optimization","type":"string","enum":["NEW","APPROVED","SKIPPED","FIXED","ERROR"],"example":"NEW"},"Suggestion":{"type":"object","properties":{"id":{"description":"UUID of this suggestion","$ref":"#/components/schemas/Id"},"opportunityId":{"description":"UUID of the opportunity this suggestion belongs to","$ref":"#/components/schemas/Id"},"type":{"$ref":"#/components/schemas/SuggestionType"},"rank":{"description":"Type-specific numeric rank value (e.g., \"domainTraffic\" for a broken-backlink) helps sorting","type":"number","example":45600},"data":{"description":"Map containing type-specific details of what fix is suggested","type":"object","additionalProperties":true,"oneOf":[{"$ref":"#/components/schemas/BrokenBacklinksRedirectData"},{"$ref":"#/components/schemas/BrokenInternalLinksSuggestionData"}]},"kpiDeltas":{"description":"Map containing metrics estimated to experience lifts or losses due to the issue","type":"object","additionalProperties":true,"oneOf":[{"$ref":"#/components/schemas/BrokenBacklinksKpiDeltas"},{"$ref":"#/components/schemas/BrokenInternalLinksKpiDeltas"}]},"status":{"description":"Status of this suggestion; status reflects overall fix execution, flagged here for optimization","$ref":"#/components/schemas/SuggestionStatus"},"createdAt":{"description":"UTC timestamp of when the suggestion was created","$ref":"#/components/schemas/DateTime"},"updatedAt":{"description":"UTC timestamp of when the suggestion was last updated","$ref":"#/components/schemas/DateTime"}},"required":["id","opportunityId","type","rank","data","status","createdAt","updatedAt"]},"SuggestionList":{"type":"array","items":{"$ref":"#/components/schemas/Suggestion"}},"SuggestionCreate":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/SuggestionType"},"rank":{"description":"Type-specific numeric rank value (e.g., \"domainTraffic\" for a broken-backlink) helps sorting","type":"number","example":45600},"data":{"description":"Map containing type-specific details of what fix is suggested","type":"object","additionalProperties":true,"oneOf":[{"$ref":"#/components/schemas/BrokenBacklinksRedirectData"},{"$ref":"#/components/schemas/BrokenInternalLinksSuggestionData"}]},"kpiDeltas":{"description":"Map containing metrics estimated to experience lifts or losses due to the issue","type":"object","additionalProperties":true,"oneOf":[{"$ref":"#/components/schemas/BrokenBacklinksKpiDeltas"},{"$ref":"#/components/schemas/BrokenInternalLinksKpiDeltas"}]}},"required":["opportunityId","type","rank","data"]},"SuggestionCreateList":{"type":"array","items":{"$ref":"#/components/schemas/SuggestionCreate"}},"SuggestionOperationSuccess":{"type":"object","description":"Success response for a suggestion operation","properties":{"index":{"description":"Index of this suggestion in the list from the request body, starting from 0","type":"integer","minimum":0},"statusCode":{"description":"HTTP status code indicating the type of success","type":"integer"},"suggestion":{"$ref":"#/components/schemas/Suggestion"}},"required":["index","statusCode","suggestion"]},"SuggestionCreateFailure":{"type":"object","description":"Suggestion create failure response","properties":{"index":{"description":"Index of this suggestion in the list from the request body, starting from 0","type":"integer","minimum":0},"statusCode":{"description":"HTTP status code indicating the type of failure","type":"integer"},"message":{"description":"Error message describing the failure","type":"string"}},"required":["index","statusCode","message"]},"SuggestionCreateListResponse":{"type":"object","description":"Suggestion create list response","properties":{"suggestions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/SuggestionOperationSuccess"},{"$ref":"#/components/schemas/SuggestionCreateFailure"}]}},"metadata":{"type":"object","properties":{"total":{"description":"Total number of suggestions in the response","type":"integer"},"success":{"description":"Number of suggestions successfully create","type":"integer"},"failure":{"description":"Number of suggestions that failed to create","type":"integer"}},"required":["total","success","failure"]}},"required":["suggestions","metadata"]},"SuggestionUpdate":{"type":"object","properties":{"rank":{"description":"Type-specific numeric rank value (e.g., \"domainTraffic\" for a broken-backlink) helps sorting","type":"number","example":12300},"data":{"description":"Map containing type-specific details of what fix is suggested","type":"object","additionalProperties":true,"oneOf":[{"$ref":"#/components/schemas/BrokenBacklinksRedirectData"},{"$ref":"#/components/schemas/BrokenInternalLinksSuggestionData"}]},"kpiDeltas":{"description":"Map containing metrics estimated to experience lifts or losses due to the issue","type":"object","additionalProperties":true,"oneOf":[{"$ref":"#/components/schemas/BrokenBacklinksKpiDeltas"},{"$ref":"#/components/schemas/BrokenInternalLinksKpiDeltas"}]}}},"SuggestionStatusUpdate":{"type":"array","items":{"type":"object","properties":{"id":{"description":"UUID of this suggestion","readOnly":false,"$ref":"#/components/schemas/Id"},"status":{"description":"Status of this suggestion; status reflects overall fix execution, flagged here for optimization","$ref":"#/components/schemas/SuggestionStatus"}},"required":["id","status"]}},"SuggestionUpdateFailure":{"type":"object","description":"Suggestion update failure","properties":{"id":{"description":"UUID of this suggestion","$ref":"#/components/schemas/Id"},"index":{"description":"Index of this suggestion in the list from the request body, starting from 0","type":"integer","minimum":0},"statusCode":{"description":"HTTP status code indicating the type of failure","type":"integer"},"message":{"description":"Error message describing the failure","type":"string"}},"required":["id","index","statusCode","message"]},"SuggestionStatusUpdateListResponse":{"type":"object","description":"Suggestions status update response","properties":{"suggestions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/SuggestionOperationSuccess"},{"$ref":"#/components/schemas/SuggestionUpdateFailure"}]}},"metadata":{"type":"object","properties":{"total":{"description":"Total number of suggestions in the response","type":"integer"},"success":{"description":"Number of suggestions successfully updated","type":"integer"},"failure":{"description":"Number of suggestions that failed to update","type":"integer"}},"required":["total","success","failure"]}},"required":["suggestions","metadata"]},"KeyEventType":{"type":"string","enum":["performance","seo","content","code","third party","experimentation","network","status change"]},"KeyEvent":{"type":"object","properties":{"id":{"description":"The key event ID in uuid format","$ref":"#/components/schemas/Id"},"name":{"description":"Name of the key event","type":"string"},"type":{"$ref":"#/components/schemas/KeyEventType"},"time":{"description":"Time of the key event occurred","$ref":"#/components/schemas/DateTime"}},"example":{"id":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","name":"Multiple 404s detected","type":"seo","time":"2023-12-15T09:30:00Z"}},"KeyEventsList":{"type":"array","items":{"$ref":"#/components/schemas/KeyEvent"}},"KeyEventCreate":{"type":"object","required":["name","type"],"properties":{"name":{"description":"Name of the key event","type":"string"},"type":{"$ref":"#/components/schemas/KeyEventType"},"time":{"description":"Time of the key event occurred (optional). Current time is used when the field is missing","$ref":"#/components/schemas/DateTime"}}},"SiteTopPage":{"type":"object","required":["siteId","url","traffic","source","geo","importedAt"],"properties":{"siteId":{"description":"The site ID in uuid format","$ref":"#/components/schemas/Id"},"url":{"description":"The URL of the top page","$ref":"#/components/schemas/URL"},"traffic":{"description":"The traffic of the top page","type":"integer"},"source":{"description":"The source of the top page listing","type":"string"},"geo":{"description":"The geo of the top page listing, or 'global' if not specific to a geo","type":"string"},"importedAt":{"description":"The date and time when the top page was imported","$ref":"#/components/schemas/DateTime"}},"example":{"siteId":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","url":"https://example-site.com/foo/bar","traffic":360420000,"source":"ahrefs","geo":"au","importedAt":"2024-04-29T15:14:33.653Z"}},"SiteTopPageList":{"type":"array","items":{"$ref":"#/components/schemas/SiteTopPage"}},"SiteMetric":{"type":"object","required":["siteId","source","name","value","time"],"properties":{"siteId":{"description":"The site ID in uuid format","$ref":"#/components/schemas/Id"},"source":{"description":"The source for retrieving the metric value","type":"string"},"name":{"description":"The name of the metric","type":"string"},"value":{"description":"The value of the metric","type":"integer"},"time":{"description":"The date and time when the metric was recorded","$ref":"#/components/schemas/DateTime"}},"example":{"siteId":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","source":"ahrefs","name":"organic-traffic","value":37900,"time":"2024-04-29T00:00:00.000Z"}},"SiteMetricList":{"type":"array","items":{"$ref":"#/components/schemas/SiteMetric"}},"PageOrganicKeywords":{"type":"object","required":["siteId","source","name","time","url","keyword","traffic"],"properties":{"siteId":{"description":"The site ID in uuid format","$ref":"#/components/schemas/Id"},"source":{"description":"The source for retrieving the metric value","type":"string"},"name":{"description":"The name of the metric","type":"string"},"time":{"description":"The date and time when the metric was recorded","$ref":"#/components/schemas/DateTime"},"url":{"description":"The URL of the page","$ref":"#/components/schemas/URL"},"keyword":{"description":"The keyword","type":"string"},"traffic":{"description":"The traffic of the keyword","type":"integer"},"volume":{"description":"The search volume of the keyword","type":"integer"},"bestPosition":{"description":"The best position of the keyword","type":"integer"},"cpc":{"description":"The cost per click of the keyword","type":"integer"},"isBranded":{"description":"Whether the keyword is branded","type":"boolean"}},"example":{"siteId":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","source":"ahrefs","name":"organic-keywords","time":"2024-04-29T00:00:00.000Z","url":"https://example.com/foo/bar","keyword":"foo bar example","traffic":2355,"volume":2400,"bestPosition":1,"cpc":89,"isBranded":true}},"PageMetricList":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/PageOrganicKeywords"}]}},"SiteExperimentVariant":{"type":"object","properties":{"name":{"description":"The name of the variant","type":"string"},"label":{"description":"The label of the variant","type":"string"},"split":{"description":"The split allocation of the traffic to the variant","type":"number"},"url":{"description":"The url of the variant","$ref":"#/components/schemas/URL"},"views":{"description":"The number of views for the variant","type":"integer"},"samples":{"description":"The number of data points (samples) used for this variant","type":"integer"},"interactionsCount":{"description":"The interactions count for the variant","type":"integer"},"p_value":{"description":"The p-value of the variant for the configured metric or clicks","type":"number"},"power":{"description":"The power of the variant for the configured metric or clicks","type":"number"},"statsig":{"description":"The statistical significance of the variant based on the configured metric or clicks","type":"boolean"},"metrics":{"description":"The metrics for the variant","type":"array","items":{"type":"object","properties":{"selector":{"description":"The css selector of the element on which the interaction was performed","type":"string"},"value":{"description":"The value of the metric on the selector","type":"number"},"samples":{"description":"The number of data points (samples) used for calculating this metric object","type":"integer"},"type":{"description":"The type of the metric","type":"string","enum":["click","convert","formsubmit"]}}}}},"example":{"name":"challenger-1","label":"Challenger 1","split":0.5,"url":"https://example-site.com/foo/bar","views":1000,"samples":10,"interactionsCount":200,"p_value":0.04,"power":97.6,"statsig":true,"metrics":[{"selector":".add-to-cart","value":300,"samples":3,"type":"click"}]}},"SiteExperiment":{"type":"object","properties":{"siteId":{"description":"The site ID in uuid format","$ref":"#/components/schemas/Id"},"experimentId":{"description":"The ID of the experiment","type":"string"},"name":{"description":"The name of the experiment","type":"string"},"url":{"description":"The URL of the experiment","$ref":"#/components/schemas/URL"},"status":{"description":"The status of the experiment","type":"string","enum":["ACTIVE","COMPLETE","INACTIVE"]},"type":{"description":"The type of the experiment","type":"string","enum":["FULL","AB","MAB"]},"startDate":{"description":"The start date and time of the experiment","$ref":"#/components/schemas/DateTime"},"endDate":{"description":"The end date and time of the experiment","$ref":"#/components/schemas/DateTime"},"variants":{"description":"The variants of the experiment","type":"array","items":{"$ref":"#/components/schemas/SiteExperimentVariant"}},"updatedAt":{"description":"The date and time when the experiment was last updated","$ref":"#/components/schemas/DateTime"},"updatedBy":{"description":"The user/entity who last updated the experiment","type":"string"},"conversionEventName":{"description":"The name of the conversion event","type":"string"},"conversionEventValue":{"description":"The name of conversion event value","type":"string"}},"example":{"siteId":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","experimentId":"1012-home-page-optimization","name":"1012 Home Page Optimization","url":"https://example-site.com/foo/bar","type":"AB","status":"ACTIVE","startDate":"2024-04-29T15:14:33.653Z","endDate":"2024-05-29T15:14:33.653Z","variants":[{"name":"challenger-1","label":"Challenger 1","split":0.5,"url":"https://example-site.com/foo/bar","views":1000,"samples":10,"interactionsCount":200,"p_value":0.04,"power":97.6,"statsig":true,"metrics":[{"selector":".add-to-cart","value":300,"samples":3,"type":"click"}]}],"updatedAt":"2024-05-31T15:14:33.653Z","updatedBy":"admin","conversionEventName":"click","conversionEventValue":".add-to-cart"}},"SiteExperimentList":{"type":"array","items":{"$ref":"#/components/schemas/SiteExperiment"}},"ImsUserAccessToken":{"type":"string","example":"eyJhbGciOiJIUzI1NiJ9.eyJpZCI6IjEyMzQ1IiwidHlwZSI6ImFjY2Vzc190b2tlbiIsImNsaWVudF9pZCI6ImV4YW1wbGVfYXBwIiwidXNlcl9pZCI6Ijk4NzY1NDc4OTBBQkNERUYxMjM0NTY3OEBhYmNkZWYxMjM0NTY3ODkuZSIsImFzIjoiaW1zLW5hMSIsImFhX2lkIjoiMTIzNDU2Nzg5MEFCQ0RFRjEyMzQ1Njc4QGFkb2JlLmNvbSIsImNyZWF0ZWRfYXQiOiIxNzEwMjQ3MDAwMDAwIn0.MRDpxgxSHDj4DmA182hPnjMAnKkly-VUJ_bXpQ-J8EQ"},"SlackInviteToChannelByUserIdRequest":{"type":"object","required":["imsOrgId","imsUserAccessToken"],"properties":{"imsOrgId":{"description":"The ID of the Adobe IMS organization","$ref":"#/components/schemas/ImsOrganizationId"},"imsUserAccessToken":{"description":"The IMS access token of the user to invite to the Slack channel","$ref":"#/components/schemas/ImsUserAccessToken"}}},"ScopeName":{"type":"string","enum":["imports.write","imports.read","imports.assistant"]},"ApiKeyMetadataResponse":{"type":"object","properties":{"id":{"description":"The ID of the API key","$ref":"#/components/schemas/Id"},"name":{"description":"The name of the API key","type":"string"},"scopes":{"description":"The scopes of the API key","type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the scope","type":"string","$ref":"#/components/schemas/ScopeName"},"domains":{"description":"The domains the scope is allowed to access","type":"array","items":{"$ref":"#/components/schemas/Domain"}}}}},"createdAt":{"description":"The date and time when the API key was created","$ref":"#/components/schemas/DateTime"},"expiresAt":{"description":"The date and time when the API key expires","$ref":"#/components/schemas/DateTime"},"deletedAt":{"description":"The date and time when the API key was deleted","$ref":"#/components/schemas/DateTime"},"revokedAt":{"description":"The date and time when the API key was revoked","$ref":"#/components/schemas/DateTime"}}},"ApiKeyRequest":{"type":"object","required":["name","features","domains"],"properties":{"name":{"description":"The name of the API key","type":"string"},"features":{"description":"The features the API key is for","type":"array","items":{"type":"string"}},"domains":{"description":"The domains the API key is allowed to access","type":"array","items":{"type":"string","$ref":"#/components/schemas/Domain"}}},"example":{"name":"Example API Key","features":["imports"],"domains":["example.com"]}},"ApiKeyResponse":{"allOf":[{"$ref":"#/components/schemas/ApiKeyMetadataResponse"},{"type":"object","properties":{"apiKey":{"description":"The API key","type":"string"}}}]},"ImportJobRequest":{"type":"object","required":["urls"],"properties":{"urls":{"description":"The URLs to import","type":"array","items":{"$ref":"#/components/schemas/URL"}},"options":{"description":"Optional configuration params, defined as a JSON object","$ref":"#/components/schemas/ImportOptions"},"importScript":{"description":"Optional import.js mapping file","type":"string","format":"binary"},"customHeaders":{"description":"Optional custom headers to send with each HTTP request","type":"object"}},"example":{"urls":["https://example.com/en/page1","https://example.com/fr/page2"],"options":{"enableJavascript":true},"importScript":"(binary data)","customHeaders":{"example-header-name":"example-header-value"}}},"ImportJobStatus":{"type":"object","properties":{"id":{"description":"The ID of the import job","$ref":"#/components/schemas/Id"},"status":{"description":"The status of the import job","type":"string","enum":["RUNNING","COMPLETE","FAILED"]},"startTime":{"description":"The date and time when the import job started.","$ref":"#/components/schemas/DateTime"},"endTime":{"description":"The date and time when the import job ended, if finished.","$ref":"#/components/schemas/DateTime"},"urlCount":{"description":"The total number of URLs in the job.","type":"integer"},"successCount":{"description":"The number of URLs successfully imported.","type":"integer"},"failedCount":{"description":"The number of URLs that failed to import.","type":"integer"},"redirectCount":{"description":"The number of URLs that were redirected.","type":"integer"}},"example":{"id":"12d6ac8e-d5e4-4788-90eb-b69e10e745fd","status":"RUNNING","startTime":"2024-01-19T14:20:30Z","urlCount":25,"successCount":15,"failedCount":0}},"ImportJobStopRequest":{"type":"object","properties":{"op":{"description":"The operation to perform on the import job","type":"string","enum":["replace"]},"path":{"description":"The path of the attribute to update","type":"string","example":"/status"},"value":{"description":"The value to set","type":"string","enum":["STOPPED"]}}},"ImportJobProgress":{"type":"object","properties":{"pending":{"type":"integer","description":"The number of pending url jobs still to process."},"redirect":{"type":"integer","description":"The number of urls that resulted in a redirect."},"running":{"type":"integer","description":"The number of url jobs that are running."},"completed":{"type":"integer","description":"The number of url jobs that have completed."},"failed":{"type":"integer","description":"The number of url jobs that have failed."}},"example":{"pending":0,"redirect":0,"running":0,"completed":1,"failed":0}},"ImportJobArchive":{"type":"object","properties":{"jobId":{"description":"The ID of the import job","$ref":"#/components/schemas/Id"},"downloadUrl":{"description":"The pre-signed URL to download the archive of the import job","$ref":"#/components/schemas/URL"}},"example":{"jobId":"12d6ac8e-d5e4-4788-90eb-b69e10e745fd","downloadUrl":"https://spacecat-example-bucket.s3.example-region.amazonaws.com/import/12d6ac8e-d5e4-4788-90eb-b69e10e745fd/import-result.zip?X-Amz-Algorithm=AWS..."}},"ImportAssistantRequest":{"type":"object","required":["command"],"properties":{"command":{"description":"Assistant command to execute. Examples 'findMainContent', 'findRemovalSelectors', 'findBlockSelectors', 'findBlockCells', 'generatePageTransformation'.","type":"string"},"prompt":{"description":"Optional prompt to provide context for the analysis. It is required for all commands except 'findMainContent'.","type":"string"},"htmlContent":{"description":"The HTML to be inspected. It is required for most commands. Removing unnecessary content and properties will reduce the number of credits used.","type":"string"},"imageUrl":{"description":"A base64 encoded image.  It is required for specific commands like 'findBlockSelectors'.","type":"string"},"selector":{"description":"A CSS selector indicating the element to inspect in the provided htmlContent. It is required for specific commands like 'findBlockCells'.","type":"string"}},"example":{"command":"findBlockSelectors","prompt":"rectangle with blue background, a heading and paragraph text","imageUrl":"data:image/png;base64,iVBORw0KGgoAAAANS...","htmlContent":"<html>...</html>"}},"ImportAssistantResponse":{"type":"object","properties":{"choices":{"description":"The choices available from the assistant command.","type":"array","items":{"type":"object","properties":{"message":{"description":"The message from the assistant command.","type":"object","properties":{"content":{"description":"The content of the message.","type":"string"}}}}}}},"example":{"choices":[{"message":{"content":"div.main div.product"}}]}},"EmailAddress":{"type":"string","format":"email","example":"user@example.com"}},"examples":{"analytics-site-integration-aa-tags":{"summary":"Example for an integration with Adobe Analytics via Adobe Tags","value":{"siteId":"a31fa5e4-90be-4440-a063-e6d6aa5a127a","reporting":{"link":"https://www5.an.adobe.com/x/5_19xzaq4","timezone":"UTC-07:00"},"dataCollection":{"type":"adobe-tags","environments":{"development":"https://assets.adobedtm.com/51b39232f777/342ccd9ca453/launch-e2732f4a5678-development.min.js","production":"https://assets.adobedtm.com/51b39232f777/342ccd9ca453/launch-e2732f4a5678.min.js"}},"dataStore":{"type":"adobe-analytics","id":"ageo1xxpnwexamplerumanalytics"},"dataMapping":{"type":"adobe-analytics","mappings":{"All Page Views":"event4","Page URL":"evar2","Data Source":"evar3","Site Domain":"evar4"}}}},"analytics-site-integration-aa-aep-websdk":{"summary":"Example for an integration with Adobe Analytics via Adobe Experience Platform and WebSDK","value":{"siteId":"a31fa5e4-90be-4440-a063-e6d6aa5a127a","reporting":{"link":"https://www5.an.adobe.com/x/5_19xzaq4","timezone":"UTC-07:00"},"dataCollection":{"type":"aep-websdk","environments":{"development":"caad777c-c410-4ceb-8b36-167f12435","production":"caad777c-c410-4ceb-43f2-167f12435"}},"dataStore":{"type":"adobe-analytics","id":"ageo1xxpnwexamplerumanalytics"},"dataMapping":{"type":"xdm","mappings":{"All Page Views":"web.webPageDetails.pageViews.value","Page URL":"web.webPageDetails.URL","Data Source":"_example.dataSource","Site Domain":"web.webPageDetails.server"}}}},"analytics-site-integration-cja-tags":{"summary":"Example for an integration with Customer Adobe Analytics via Adobe Experience Platform and Adobe Tags","value":{"siteId":"a31fa5e4-90be-4440-a063-e6d6aa5a127a","reporting":{"link":"https://analytics.adobe.com/?linkId=8296eaea-aa9a-4840-8a86-71df75661&dpc=acc","timezone":"UTC-07:00"},"dataCollection":{"type":"adobe-tags","environments":{"development":"https://assets.adobedtm.com/51b39232f777/342ccd9ca453/launch-e2732f4a5678-development.min.js","production":"https://assets.adobedtm.com/51b39232f777/342ccd9ca453/launch-e2732f4a5678.min.js"}},"dataStore":{"type":"aep","id":"64cd250cdc886828d309a2215"},"dataSchema":{"id":"https://ns.adobe.com/example/schemas/203ff63ed073c85d5fad4274f27d2fc2e9b834b06778f8"},"dataMapping":{"type":"xdm","mappings":{"All Page Views":"web.webPageDetails.pageViews.value","Page URL":"web.webPageDetails.URL","Data Source":"_example.dataSource","Site Domain":"web.webPageDetails.server"}}}},"analytics-site-integration-cja-websdk":{"summary":"Example for an integration with Customer Adobe Analytics via Adobe Experience Platform and WebSDK","value":{"siteId":"a31fa5e4-90be-4440-a063-e6d6aa5a127a","reporting":{"link":"https://analytics.adobe.com/?linkId=8296eaea-aa9a-4840-8a86-71df75661&dpc=acc","timezone":"UTC-07:00"},"dataCollection":{"type":"aep-websdk","environments":{"development":"caad777c-c410-4ceb-8b36-167f12435","production":"caad777c-c410-4ceb-43f2-167f12435"}},"dataStore":{"type":"aep","id":"64cd250cdc886828d309a2215"},"dataSchema":{"id":"https://ns.adobe.com/example/schemas/203ff63ed073c85d5fad4274f27d2fc2e9b834b06778f8"},"dataMapping":{"type":"xdm","mappings":{"All Page Views":"web.webPageDetails.pageViews.value","Page URL":"web.webPageDetails.URL","Data Source":"_example.dataSource","Site Domain":"web.webPageDetails.server"}}}},"generic-audit":{"summary":"Example for a generic audit","value":{"siteId":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","auditedAt":"2024-01-20T12:00:00Z","expiresAt":"2024-07-20T12:00:00Z","auditType":"cwv","isError":false,"deliveryType":"aem_edge","fullAuditRef":"https://some-audit-system/full-report/1234","auditResult":{"someProperty":"someValue"},"previousAuditResult":{"someProperty":"somePreviousValue"}}},"broken-backlinks-audit":{"summary":"Example for a broken-backlinks audit","value":{"siteId":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","auditedAt":"2024-01-20T12:00:00Z","expiresAt":"2024-07-20T12:00:00Z","auditType":"broken-backlinks","deliveryType":"aem_edge","isError":false,"isLive":true,"fullAuditRef":"https://api.ahrefs.com/v3/site-explorer/broken-backlinks?select=title%2Curl_from%2Curl_to%2Ctraffic_domain&limit=50&mode=prefix&order_by=domain_rating_source%3Adesc%2Ctraffic_domain%3Adesc&target=example.com&output=json&where=%7B%22and%22%3A%5B%7B%22field%22%3A%22is_dofollow%22%2C%22is%22%3A%5B%22eq%22%2C1%5D%7D%2C%7B%22field%22%3A%22is_content%22%2C%22is%22%3A%5B%22eq%22%2C1%5D%7D%2C%7B%22field%22%3A%22domain_rating_source%22%2C%22is%22%3A%5B%22gte%22%2C29.5%5D%7D%2C%7B%22field%22%3A%22traffic_domain%22%2C%22is%22%3A%5B%22gte%22%2C500%5D%7D%2C%7B%22field%22%3A%22links_external%22%2C%22is%22%3A%5B%22lte%22%2C300%5D%7D%5D%7D","auditResult":{"brokenBacklinks":{"urls_suggested":["https://www.example.com/article/cats/pet-care/selecting-the-right-toys-for-your-cats-play-preference"],"url_to":"https://www.example.com/article/cats/pet-care/safe-and-sound-toys-for-your-cat/","title":"Choosing the Best Cat Toys: A Comprehensive Guide - Petful","url_from":"https://www.petful.com/pet-products/choosing-the-best-cat-toys/","traffic_domain":65272}}}},"costs-audit":{"summary":"Example for a costs audit","value":{"ahrefs":{"usedApiUnits":198771,"limitApiUnits":1000000,"fullAuditRef":"https://api.ahrefs.com/v3/subscription-info/limits-and-usage"}}},"meta-tags-audit":{"summary":"Example for a meta-tags audit","value":{"auditResult":{"sourceS3Folder":"spacecat-scraper-dev/scrapes/cccdac43-1a22-4659-9086-b762f59b9928/","detectedTags":{"/de":{"title":{"seoRecommendation":"Should be present","issue":"Missing Title","issueDetails":"Title tag is missing","seoImpact":"High"}}},"finalUrl":"www.bulk.com/uk/"},"auditType":"meta-tags","auditedAt":"2025-01-03T10:14:41.798Z","fullAuditRef":null,"isLive":true,"isError":false,"siteId":"cccdac43-1a22-4659-9086-b762f59b9928"}},"broken-internal-links-audit":{"summary":"Example for a broken-internal-links audit","value":{"siteId":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","auditedAt":"2024-01-20T12:00:00Z","expiresAt":"2024-07-20T12:00:00Z","auditType":"broken-internal-links","deliveryType":"aem_edge","isError":false,"isLive":true,"fullAuditRef":"https://petplace.com","auditResult":{"brokenInternalLinks":{"urlsSuggested":["https://www.example.com/article/cats/pet-care/selecting-the-right-toys-for-your-cats-play-preference"],"urlTo":"https://www.example.com/article/cats/pet-care/safe-and-sound-toys-for-your-cat/","title":"Choosing the Best Cat Toys: A Comprehensive Guide","urlFrom":"https://www.example.com/article/cats/pet-care/toys-for-your-cat/","aiRationale":"The URL is about toys for your cat, so it should be redirected to the toys for your cat page.","priority":"high","trafficDomain":65272},"finalUrl":"www.example.com/uk/"}}},"broken-backlinks-opportunity-create":{"description":"Example for a broken backlinks opportunity create","value":{"auditId":"123e4567-e89b-12d3-a456-426614174000","runbook":"https://example.com/runbook/broken-backlinks","type":"broken-backlinks","origin":"AUTOMATION","title":"Authoritative domains are linking to invalid SecurBank URLs. This could impact your SEO.","description":"Provide the correct target URL that each of the broken backlinks should be redirected to.","guidance":{"steps":["Review the list of broken target URLs and the suggested redirects.","Manually override redirect URLs as needed.","Copy redirects.","Paste new entries in your website redirects file.","Publish the changes."]},"tags":["Traffic acquisition"]}},"broken-backlinks-opportunity":{"description":"Example for a broken backlinks opportunity","value":{"id":"123e4567-e89b-12d3-a456-426614174000","siteId":"a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14","auditId":"123e4567-e89b-12d3-a456-426614174000","runbook":"https://example.com/runbook/broken-backlinks","type":"broken-backlinks","origin":"AUTOMATION","title":"Authoritative domains are linking to invalid SecurBank URLs. This could impact your SEO.","description":"Provide the correct target URL that each of the broken backlinks should be redirected to.","status":"IN_PROGRESS","guidance":{"steps":["Review the list of broken target URLs and the suggested redirects.","Manually override redirect URLs as needed.","Copy redirects.","Paste new entries in your website redirects file.","Publish the changes."]},"tags":["Traffic acquisition"],"createdAt":"2024-01-20T12:00:00Z","updatedAt":"2024-07-23T12:00:00Z"}},"broken-backlinks-opportunity-update":{"description":"Example for a broken backlinks opportunity update","value":{"runbook":"https://example.com/runbook/broken-backlinks-v2","title":"10 authoritative domains are linking to invalid SecurBank URLs. This could impact your SEO."}},"broken-backlinks-suggestion-create-list":{"description":"Example for a broken backlinks suggestion create list","value":[{"type":"REDIRECT_UPDATE","rank":571000,"data":null,"title":"Black Friday Sale at Example Inc.","url_from":"https://www.dailynews.com/2024/08/13/black-friday-sale-at-example-inc/","url_to":"https://www.example.com/CustomerServiceView.aspx","urls_suggested":["https://www.example.com/customer-service/contact","https://www.example.com/customer-service"],"ai_rationale":"The URL is about customer service, so it should be redirected to the customer service page.","traffic_domain":571000},{"type":"REDIRECT_UPDATE","rank":123000,"data":{"title":"Black Friday Sale at Example Inc.","url_from":"https://www.dailynews.com/2024/08/13/black-friday-sale-at-example-inc/","url_to":"https://www.example.com/get-a-promo-code.aspx","urls_suggested":["https://www.example.com/offers/promo-codes"],"traffic_domain":123000}}]},"broken-backlinks-suggestion-create-list-response":{"description":"Example for a broken backlinks suggestion create list response","value":{"suggestions":[{"index":0,"statusCode":201,"suggestion":{"id":"2563e4567-f543-12d3-a456-426614174000","opportunityId":"123e4567-e89b-12d3-a456-426614174000","type":"REDIRECT_UPDATE","status":"NEW","rank":571000,"data":{"title":"Black Friday Sale at Example Inc.","url_from":"https://www.dailynews.com/2024/08/13/black-friday-sale-at-example-inc/","url_to":"https://www.example.com/CustomerServiceView.aspx","urls_suggested":["https://www.example.com/customer-service/contact","https://www.example.com/customer-service"],"traffic_domain":571000},"createdAt":"2024-01-22T12:00:00Z","updatedAt":"2024-07-26T12:00:00Z"}},{"index":1,"statusCode":400,"message":"Validation failed in suggestion: type is required"}],"metadata":{"total":2,"success":1,"failure":1}}},"broken-backlinks-suggestion":{"description":"Example for a broken backlinks suggestion","value":{"id":"213e4567-f543-12d3-a456-426614174000","opportunityId":"123e4567-e89b-12d3-a456-426614174000","type":"REDIRECT_UPDATE","rank":571000,"data":{"title":"Black Friday Sale at Example Inc.","url_from":"https://www.dailynews.com/2024/08/13/black-friday-sale-at-example-inc/","url_to":"https://www.example.com/CustomerServiceView.aspx","urls_suggested":["https://www.example.com/customer-service/contact","https://www.example.com/customer-service"],"ai_rationale":"The URL is about customer service, so it should be redirected to the customer service page.","traffic_domain":571000},"status":"APPROVED","createdAt":"2024-01-22T12:00:00Z","updatedAt":"2024-07-26T12:00:00Z"}},"broken-backlinks-suggestion-update":{"description":"Example for a broken backlinks suggestion","value":{"rank":571000,"data":{"proposedTargetURLs":["https://www.example.com/customer-service/contact"],"manualOverrideURL":"https://www.example.com/customer-service/faq"}}},"broken-backlinks-suggestions-status-update":{"description":"Example for broken backlinks suggestions status update","value":[{"id":"213e4567-f543-12d3-a456-426614174000","status":"APPROVED"},{"id":"945e4567-f543-12d3-a456-426614174010","status":"SKIPPED"}]},"broken-backlinks-suggestions-status-update-response":{"description":"Example for broken backlinks suggestions status update response","value":{"suggestions":[{"index":0,"statusCode":200,"suggestion":{"id":"213e4567-f543-12d3-a456-426614174000","opportunityId":"123e4567-e89b-12d3-a456-426614174000","type":"REDIRECT_UPDATE","rank":571000,"data":{"title":"Black Friday Sale at Example Inc.","url_from":"https://www.dailynews.com/2024/08/13/black-friday-sale-at-example-inc/","url_to":"https://www.example.com/CustomerServiceView.aspx","urls_suggested":["https://www.example.com/customer-service/contact","https://www.example.com/customer-service"],"traffic_domain":571000},"status":"APPROVED","createdAt":"2024-01-22T12:00:00Z","updatedAt":"2024-07-26T12:00:00Z"}},{"id":"945e4567-f543-12d3-a456-426614174010","index":1,"statusCode":400,"message":"Validation failed in suggestion: status must be one of NEW,APPROVED,SKIPPED,FIXED,ERROR"}],"metadata":{"total":2,"success":1,"failure":1}}}},"parameters":{"auditType":{"name":"auditType","description":"The type of the audit","in":"path","required":true,"schema":{"$ref":"#/components/schemas/AuditType"}},"ascending":{"name":"ascending","description":"Whether to sort ascending or descending","in":"query","required":false,"schema":{"type":"boolean","default":false}},"siteId":{"name":"siteId","description":"The site ID in uuid format","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Id"}},"hookSecret":{"name":"hookSecret","description":"Secret for the incoming webhook","in":"path","required":true,"schema":{"type":"string"}},"organizationId":{"name":"organizationId","description":"The organization ID in uuid format","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Id"}},"imsOrgId":{"name":"imsOrgId","description":"An IMS organization ID","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ImsOrganizationId"}},"deliveryType":{"name":"deliveryType","description":"The type of the delivery this site is using","in":"path","required":true,"schema":{"$ref":"#/components/schemas/DeliveryType"}},"base64BaseUrl":{"name":"base64BaseUrl","description":"Base64-encoded base URL","in":"path","required":true,"schema":{"type":"string","format":"base64url"}},"auditedAt":{"name":"auditedAt","description":"The date and time of the audit in ISO 8601 format","in":"path","required":true,"schema":{"$ref":"#/components/schemas/DateTime"}},"opportunityId":{"name":"opportunityId","description":"The opportunity ID in uuid format","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Id"}},"suggestionId":{"name":"suggestionId","description":"The suggestion ID in uuid format","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Id"}},"keyEventId":{"name":"keyEventId","description":"The key event ID in uuid format","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Id"}},"source":{"name":"source","description":"The source of the top pages","in":"path","required":true,"schema":{"type":"string","enum":["ahrefs"],"example":"ahrefs"}},"geo":{"name":"geo","description":"The geo of the top pages","in":"path","required":true,"schema":{"type":"string","example":"au"}},"metric":{"name":"metric","description":"The name of the site metric","in":"path","required":true,"schema":{"type":"string","enum":["organic-traffic","organic-keywords"],"example":"organic-traffic"}},"base64PageUrl":{"name":"base64PageUrl","description":"Base64-encoded page URL","in":"path","required":true,"schema":{"type":"string","format":"base64url"}},"triggerUrl":{"name":"url","description":"The URL or Site ID to trigger the audit for","in":"query","required":true,"schema":{"type":"string"}},"triggerType":{"name":"type","description":"The type of the audit to trigger","in":"query","required":true,"schema":{"$ref":"#/components/schemas/AuditType"}},"apiKeyId":{"name":"apiKeyId","description":"The API key ID in uuid format","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Id"}},"jobId":{"name":"jobId","description":"The job ID in uuid format","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Id"}}},"headers":{"xError":{"description":"A short descriptive error message","schema":{"format":"none","type":"string"}}},"responses":{"400":{"description":"Invalid request.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated."},"404":{"description":"Not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Too many requests.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Internal server error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Service Unavailable.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-no-audit-type":{"description":"Bad request. Audit Type is required.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"404-configuration-not-found-with-version":{"description":"Configuration not found with this version.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-bad-hoolihan-event":{"description":"Bad request. Did not match expected Hoolihan message format.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-no-site-id":{"description":"Bad request. Site ID is required.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"404-site-not-found-with-id":{"description":"Site not found with given ID.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-empty-request-body-validation-failure":{"description":"Bad request. No or empty request body or required Organization properties missing.\n","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-no-organization-id":{"description":"Bad request. Organization ID is required.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"404-organization-not-found-with-id":{"description":"Organization not found with given ID.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-no-organization-id-request-body-no-updates":{"description":"Bad request. No or empty Organization ID is provided, or request body is empty, or no updates have been provided.\n","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-bad-ims-org-id":{"description":"Bad request. IMS org ID param was not in the expected format.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-max-scrape-urls-exceeded":{"description":"Bad request. The maximum number of URLs that can be scraped in a single request is 10.\n","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-no-delivery-type":{"description":"Bad request. Delivery Type is required.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-no-base-url":{"description":"Bad request. Base URL is required.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"404-site-not-found-with-base-url":{"description":"Site not found with given Base URL.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-no-site-id-request-body-no-updates":{"description":"Bad request. No or empty Site ID is provided, or request body is empty, or no updates have been provided.\n","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-audit-for-site":{"description":"Bad request. Site ID, Audit Type and Audited At are required.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"404-audit-not-found":{"description":"Audit not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-latest-audit-for-site":{"description":"Bad request. Site ID and Audit Type are required.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-patch-audit-for-site":{"description":"No updates provided.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-no-key-event-id":{"description":"Bad request. Key Event ID is required.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"404-key-event-not-found-with-id":{"description":"Key event not found with given ID.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"400-missing-params-or-unknown-audit-type":{"description":"Bad request. URL parameters _url_ or _type_ are missing, or audit type is unknown.\n","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"403-max-api-keys-exceeded":{"description":"Forbidden. The maximum number of API keys that can be created per client has been exceeded.\n","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}}}},"searchIndex":{"store":["section/Authentication","tag/site","tag/site/operation/getSitesForOrganization","tag/site/operation/createSite","tag/site/operation/getSites","tag/site/operation/getSitesByDeliveryType","tag/site/operation/getSiteByBaseUrl","tag/site/operation/getSitesWithLatestAudit","tag/site/paths/~1sites~1{siteId}~1latest-metrics/get","tag/site/operation/getSite","tag/site/operation/patchSite","tag/site/operation/deleteSite","tag/site/operation/patchAuditForSite","tag/site/operation/getKeyEvents","tag/site/operation/createKeyEvent","tag/site/operation/deleteKeyEvent","tag/site/operation/getSiteTopPages","tag/site/operation/getSiteTopPagesBySource","tag/site/operation/getSiteTopPagesBySourceAndGeo","tag/site/operation/getSiteMetricsBySource","tag/site/operation/getPageMetricsBySource","tag/site/operation/getExperiments","tag/audit","tag/audit/operation/getAllAudits","tag/audit/operation/getAllAuditsForSite","tag/audit/operation/getAllAuditsOfTypeForSite","tag/audit/operation/getAuditForSite","tag/audit/operation/getAllAuditsForSite","tag/audit/operation/getLatestAuditForSite","tag/audit/operation/patchAuditForSite","tag/auth","tag/auth/operation/googleAuth","tag/organization","tag/organization/operation/createOrganization","tag/organization/operation/getOrganizations","tag/organization/operation/getOrganization","tag/organization/operation/patchOrganization","tag/organization/operation/deleteOrganization","tag/organization/operation/getSitesForOrganization","tag/organization/operation/getOrganizationByImsOrgId","tag/organization/operation/getSlackConfigByImsOrgId","tag/trigger","tag/trigger/operation/triggerAudit","tag/hooks","tag/hooks/operation/processFulfillmentEvents","tag/hooks/operation/siteDetectionCdn","tag/hooks/operation/siteDetectionRum","tag/hooks/operation/processAnalyticsSiteIntegration","tag/slack","tag/slack/operation/inviteToSlackChannelByUserId","tag/api-keys","tag/api-keys/operation/createApiKey","tag/api-keys/operation/getApiKeys","tag/api-keys/operation/deleteApiKey","tag/import","tag/import/operation/startImportJob","tag/import/operation/getImportJobStatus","tag/import/operation/deleteImportJob","tag/import/operation/stopImportJob","tag/import/operation/getImportJobProgress","tag/import/operation/getImportJobArchive","tag/import/operation/processImportAssistant","tag/scrape","tag/scrape/operation/scrape","tag/configuration","tag/configuration/operation/getAllConfigurations","tag/configuration/operation/getLatestConfiguration","tag/configuration/operation/getConfigurationByVersion","tag/configuration/operation/update","tag/metrics","tag/metrics/paths/~1sites~1{siteId}~1latest-metrics/get","tag/metrics/operation/getSiteMetricsBySource","tag/metrics/operation/getPageMetricsBySource","tag/opportunities","tag/opportunities/paths/~1sites~1{siteId}~1opportunities/get","tag/opportunities/paths/~1sites~1{siteId}~1opportunities/post","tag/opportunities/paths/~1sites~1{siteId}~1opportunities~1by-status~1{status}/get","tag/opportunities/paths/~1sites~1{siteId}~1opportunities~1{opportunityId}/get","tag/opportunities/paths/~1sites~1{siteId}~1opportunities~1{opportunityId}/patch","tag/opportunities/paths/~1sites~1{siteId}~1opportunities~1{opportunityId}/delete","tag/opportunity-suggestions","tag/opportunity-suggestions/paths/~1sites~1{siteId}~1opportunities~1{opportunityId}~1suggestions/get","tag/opportunity-suggestions/paths/~1sites~1{siteId}~1opportunities~1{opportunityId}~1suggestions/post","tag/opportunity-suggestions/paths/~1sites~1{siteId}~1opportunities~1{opportunityId}~1suggestions~1by-status~1{status}/get","tag/opportunity-suggestions/paths/~1sites~1{siteId}~1opportunities~1{opportunityId}~1suggestions~1{suggestionId}/get","tag/opportunity-suggestions/paths/~1sites~1{siteId}~1opportunities~1{opportunityId}~1suggestions~1{suggestionId}/patch","tag/opportunity-suggestions/paths/~1sites~1{siteId}~1opportunities~1{opportunityId}~1suggestions~1{suggestionId}/delete","tag/opportunity-suggestions/paths/~1sites~1{siteId}~1opportunities~1{opportunityId}~1suggestions~1status/patch","tag/key-event","tag/key-event/operation/getKeyEvents","tag/key-event/operation/createKeyEvent","tag/key-event/operation/deleteKeyEvent","tag/top-pages","tag/top-pages/operation/getSiteTopPages","tag/top-pages/operation/getSiteTopPagesBySource","tag/top-pages/operation/getSiteTopPagesBySourceAndGeo","tag/experiments","tag/experiments/operation/getExperiments"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,3.866]],["description/0",[1,6.261,2,4.995]],["title/1",[3,0.404]],["description/1",[3,0.425,4,4.07]],["title/2",[3,0.305,5,0.427,6,1.499]],["description/2",[3,0.344,5,0.482,6,1.691,7,0.577,8,0.815,9,4.456]],["title/3",[3,0.305,10,1.923,11,2.062]],["description/3",[3,0.444,7,0.577,8,0.815,10,2.17,11,2.327]],["title/4",[3,0.348,5,0.486]],["description/4",[3,0.458,5,0.506,7,0.605,8,0.856]],["title/5",[3,0.272,5,0.381,12,2.957,13,2.147]],["description/5",[3,0.329,5,0.46,7,0.551,8,0.778,12,3.575,13,2.595,14,4.845]],["title/6",[3,0.245,5,0.343,15,2.227,16,2.884,17,1.719]],["description/6",[3,0.334,5,0.242,7,0.289,8,0.641,16,3.923,17,2.647,18,2.544,19,2.234,20,1.307,21,1.567,22,3.987,23,2.544,24,2.544,25,2.029,26,2.544,27,2.544,28,2.234,29,2.544]],["title/7",[3,0.245,5,0.343,30,2.023,31,1.936,32,1.205]],["description/7",[3,0.318,5,0.298,7,0.357,8,0.505,30,2.621,31,2.509,32,2.071,33,2.505,34,2.758,35,2.758,36,2.505,37,2.758,38,3.141]],["title/8",[3,0.305,31,2.408,39,2.139]],["description/8",[3,0.186,5,0.26,6,0.913,30,1.532,31,1.467,39,2.008,40,1.303,41,2.745,42,2.405,43,1.89,44,2.405,45,3.116,46,1.605,47,1.532,48,2.405,49,2.185,50,2.185,51,2.021,52,0.913,53,1.407,54,2.405]],["title/9",[3,0.272,5,0.381,15,2.469,20,2.06]],["description/9",[3,0.344,5,0.482,7,0.577,8,0.815,20,2.608,55,4.048]],["title/10",[3,0.348,56,2.632]],["description/10",[3,0.226,7,0.379,8,0.536,21,2.055,55,2.661,56,2.983,57,4.302,58,2.661,59,3.017,60,4.302,61,2.929,62,2.302]],["title/11",[3,0.348,63,2.348]],["description/11",[3,0.362,7,0.605,8,0.856,55,4.25,63,2.443]],["title/12",[32,1.499,53,2.311,56,2.311]],["description/12",[7,0.466,8,0.659,17,1.951,32,1.893,53,2.108,56,2.108,64,3.603,65,2.667,66,3.603,67,3.603]],["title/13",[3,0.272,5,0.381,52,1.336,68,1.605]],["description/13",[3,0.278,7,0.466,47,2.295,52,1.368,68,1.643,69,3.603,70,3.027,71,4.986,72,2.404,73,3.027]],["title/14",[3,0.245,10,1.546,11,1.658,52,1.205,68,1.448]],["description/14",[3,0.329,7,0.551,10,2.072,11,2.222,52,1.615,68,1.94,73,3.575]],["title/15",[52,1.499,63,2.062,68,1.8]],["description/15",[7,0.605,52,1.776,63,2.443,68,2.133,74,4.678]],["title/16",[3,0.272,5,0.381,75,1.906,76,1.605]],["description/16",[3,0.213,5,0.298,7,0.357,8,0.505,46,1.84,72,1.84,75,2.228,76,1.876,77,1.84,78,2.407,79,3.456,80,1.44,81,2.041,82,2.317,83,2.758]],["title/17",[3,0.245,5,0.343,75,1.719,76,1.448,80,1.658]],["description/17",[3,0.22,5,0.307,7,0.368,8,0.52,46,1.896,72,1.896,75,2.278,76,1.918,77,1.896,78,2.461,79,3.534,81,2.103,82,2.387,84,2.841]],["title/18",[3,0.223,5,0.313,75,1.566,76,1.318,80,1.51,81,2.14]],["description/18",[3,0.25,5,0.35,7,0.418,8,0.591,46,2.156,72,2.156,75,2.501,76,2.106,77,2.156,78,2.703,85,3.231]],["title/19",[3,0.272,5,0.381,39,1.906,80,1.838]],["description/19",[3,0.329,5,0.46,7,0.551,8,0.778,39,2.304,80,2.222,86,4.254]],["title/20",[5,0.381,39,1.906,76,1.605,80,1.838]],["description/20",[5,0.39,7,0.466,8,0.659,39,2.7,76,1.643,80,1.881,87,3.603,88,3.603,89,3.603,90,3.603]],["title/21",[3,0.305,5,0.427,91,3.103]],["description/21",[3,0.259,7,0.433,21,2.347,41,2.477,45,2.812,91,3.72,92,2.477,93,3.346,94,1.812,95,3.346,96,2.812,97,3.346]],["title/22",[32,1.982]],["description/22",[4,4.07,32,2.087]],["title/23",[5,0.343,13,1.936,31,1.936,32,1.205,94,1.719]],["description/23",[5,0.35,7,0.418,8,0.591,13,1.971,32,1.753,78,1.891,94,1.75,98,2.539,99,2.156,100,2.715,101,2.715,102,2.715,103,3.68]],["title/24",[3,0.305,5,0.427,32,1.499]],["description/24",[3,0.259,5,0.362,7,0.433,8,0.612,32,1.797,78,1.958,98,2.629,99,2.233,100,2.812,101,2.812,102,2.812,104,3.811]],["title/25",[3,0.245,5,0.343,13,1.936,32,1.205,94,1.719]],["description/25",[3,0.241,5,0.338,7,0.404,8,0.572,13,1.905,32,1.711,78,1.828,94,1.692,98,2.454,99,2.085,100,2.625,101,2.625,102,2.625,105,3.558]],["title/26",[3,0.272,5,0.381,15,2.469,32,1.336]],["description/26",[3,0.25,5,0.35,7,0.418,8,0.591,13,1.971,15,2.266,19,3.231,32,2.232,34,3.231,35,3.231,106,3.68]],["title/27",[3,0.305,5,0.427,32,1.499]],["description/27",[3,0.259,5,0.362,7,0.433,8,0.612,32,1.797,78,1.958,98,2.629,99,2.233,100,2.812,101,2.812,102,2.812,107,3.811]],["title/28",[3,0.272,5,0.381,31,2.147,32,1.336]],["description/28",[3,0.325,5,0.307,7,0.368,8,0.52,13,1.733,30,1.81,31,2.565,32,2.101,33,2.581,36,2.581,37,2.841,94,1.539,108,3.235]],["title/29",[32,1.499,53,2.311,56,2.311]],["description/29",[7,0.466,8,0.659,17,1.951,32,1.893,53,2.108,56,2.108,64,3.603,65,2.667,66,3.603,67,3.603]],["title/30",[109,5.947]],["description/30",[0,3.299,110,5.075,111,5.075,112,5.075,113,5.075,114,3.744]],["title/31",[0,3.329,115,4.497]],["description/31",[0,3.791,7,0.485,8,0.685,43,2.943,115,5.122,116,4.266,117,4.266,118,4.266]],["title/32",[6,1.982]],["description/32",[4,4.07,6,2.087]],["title/33",[6,1.499,10,1.923,11,2.062]],["description/33",[6,2.182,7,0.577,8,0.815,10,2.17,11,2.327]],["title/34",[5,0.486,6,1.707]],["description/34",[5,0.506,6,2.25,7,0.605,8,0.856]],["title/35",[5,0.381,6,1.336,15,2.469,20,2.06]],["description/35",[5,0.482,6,1.691,7,0.577,8,0.815,20,2.608,119,4.048]],["title/36",[6,1.707,56,2.632]],["description/36",[6,1.112,7,0.379,8,0.536,21,2.055,56,2.983,57,4.302,58,2.661,59,3.017,60,4.302,61,2.929,62,2.302,119,2.661]],["title/37",[6,1.707,63,2.348]],["description/37",[6,1.776,7,0.605,8,0.856,63,2.443,119,4.25]],["title/38",[3,0.305,5,0.427,6,1.499]],["description/38",[3,0.344,5,0.482,6,1.691,7,0.577,8,0.815,9,4.456]],["title/39",[5,0.343,6,1.205,20,1.858,120,2.227,121,2.494]],["description/39",[5,0.44,6,1.545,7,0.527,8,0.745,20,2.382,120,2.855,121,3.198,122,4.636]],["title/40",[5,0.287,6,1.008,20,1.553,120,1.862,121,2.086,123,1.691,124,2.654]],["description/40",[5,0.405,6,1.422,7,0.485,8,0.685,20,2.192,120,2.627,121,2.943,123,2.387,124,3.746,125,4.266]],["title/41",[126,4.388]],["description/41",[4,4.07,126,4.619]],["title/42",[32,1.707,126,3.779]],["description/42",[2,4.03,3,0.105,7,0.176,8,0.559,13,1.864,16,1.237,17,1.262,20,0.796,28,1.361,32,1.544,33,1.237,47,0.867,62,1.069,123,0.867,126,2.567,127,1.361,128,0.737,129,1.55,130,1.361,131,1.55,132,1.361,133,1.361,134,1.55,135,1.55,136,1.55,137,1.55,138,1.55,139,1.361,140,1.144,141,1.361,142,1.55,143,1.55,144,1.55,145,1.55,146,1.55,147,1.55,148,1.55,149,1.55]],["title/43",[150,4.103]],["description/43",[68,2.368,151,4.719,152,4.719]],["title/44",[68,1.8,153,2.516,154,3.949]],["description/44",[7,0.282,8,0.629,12,1.833,36,1.982,68,1.567,114,1.833,153,1.39,154,2.182,155,2.485,156,2.485,157,4.843,158,2.485,159,2.485,160,2.485,161,2.485,162,2.485,163,2.485,164,2.485,165,2.485,166,2.485,167,2.182,168,2.485,169,2.485,170,2.485]],["title/45",[3,0.205,150,2.086,153,1.691,171,2.23,172,2.654,173,2.654,174,2.23]],["description/45",[7,0.264,30,1.3,49,1.853,51,1.714,123,1.3,150,1.603,151,1.853,152,1.853,153,1.3,171,1.714,173,2.04,174,1.714,175,2.323,176,1.853,177,2.04,178,2.04,179,2.04,180,2.961,181,3.259,182,2.04,183,1.853,184,2.04,185,1.714,186,2.04,187,1.714,188,2.04,189,2.04,190,2.04,191,2.323]],["title/46",[3,0.205,41,1.965,150,2.086,153,1.691,171,2.23,172,2.654,174,2.23]],["description/46",[7,0.264,17,1.105,30,1.3,41,1.51,51,2.738,123,1.3,150,1.603,151,1.853,152,1.853,153,1.3,171,1.714,174,1.714,177,2.04,178,2.04,179,2.04,180,2.961,181,3.259,182,2.04,183,1.853,184,2.04,185,1.714,186,2.04,187,1.714,188,2.04,189,2.04,190,2.04,192,2.323,193,2.323]],["title/47",[3,0.205,68,1.21,153,1.691,185,2.23,194,2.654,195,2.654,196,2.654]],["description/47",[3,0.278,68,1.643,77,2.404,153,2.295,185,3.027,194,3.603,195,3.603,196,3.603,197,3.603,198,4.103,199,4.103]],["title/48",[123,3.327]],["description/48",[123,3.309,200,4.719,201,5.194]],["title/49",[6,1.098,59,2.028,123,1.842,200,2.627,202,2.891,203,2.429]],["description/49",[6,0.809,7,0.276,8,0.39,20,1.975,21,1.496,43,3.292,94,1.155,120,2.938,121,1.675,123,2.151,128,1.155,197,2.132,200,3.067,202,2.132,203,1.792,204,2.429,205,2.429,206,2.429,207,2.429,208,2.429,209,2.132,210,2.429]],["title/50",[211,5.947]],["description/50",[52,1.972,128,2.813,201,5.194]],["title/51",[10,1.714,11,1.838,52,1.336,128,1.906]],["description/51",[0,1.736,7,0.303,8,0.665,10,1.142,11,1.225,30,1.494,47,1.494,52,1.691,65,1.736,128,2.718,140,1.97,176,2.131,183,2.131,209,2.345,212,4.454,213,2.671,214,2.345]],["title/52",[52,1.098,94,1.566,120,2.028,128,1.566,215,3.293,216,2.429]],["description/52",[7,0.527,8,0.745,10,1.982,52,1.545,92,3.013,128,2.204,214,4.07,216,3.42]],["title/53",[52,1.499,63,2.062,128,2.139]],["description/53",[0,2.041,7,0.357,8,0.505,10,1.343,52,1.868,63,2.569,120,1.934,128,2.228,133,2.758,180,2.505,216,2.317,217,2.758,218,3.141,219,3.141]],["title/54",[220,2.543]],["description/54",[12,3.744,114,3.744,128,2.413,167,4.456,220,2.17,221,5.075]],["title/55",[10,1.714,11,1.838,220,1.714,222,1.98]],["description/55",[7,0.317,8,0.264,11,0.754,15,1.013,17,0.782,47,1.562,50,1.312,52,0.548,58,1.312,59,1.72,65,1.069,70,1.214,98,1.926,114,1.214,128,0.782,139,1.445,140,2.06,153,0.92,176,1.312,216,1.214,220,2.053,222,2.117,223,1.645,224,1.645,225,1.445,226,1.645,227,1.013,228,1.135,229,1.214,230,1.645,231,1.645,232,1.645,233,1.645,234,1.645,235,1.645,236,1.645,237,1.645,238,1.645]],["title/56",[220,1.714,222,1.98,227,2.469,228,2.765]],["description/56",[7,0.505,8,0.714,94,2.113,220,1.9,222,2.195,227,2.736,228,3.065,229,3.278,239,3.278]],["title/57",[63,2.062,220,1.923,222,2.221]],["description/57",[4,1.51,7,0.264,8,0.596,10,0.994,17,1.105,21,1.431,52,1.237,63,2.125,94,1.105,128,1.105,130,2.04,212,2.04,220,2.263,222,2.614,229,1.714,239,1.714,240,2.323,241,2.323,242,2.323,243,2.323,244,2.323]],["title/58",[220,1.923,222,2.221,245,4.497]],["description/58",[4,1.615,7,0.282,8,0.399,11,1.139,17,1.182,25,1.982,43,1.714,70,1.833,94,1.182,99,1.456,141,2.182,217,2.182,220,2.071,222,2.392,227,1.53,229,1.833,239,1.833,246,3.914,247,2.485,248,2.485,249,1.714,250,2.485,251,2.485]],["title/59",[220,1.714,222,1.98,228,2.765,252,3.52]],["description/59",[7,0.505,8,0.714,94,2.113,220,1.9,222,2.195,228,3.065,239,3.278,252,3.902,253,4.443]],["title/60",[17,1.235,59,1.6,99,1.522,220,1.111,222,1.283,254,2.597,255,2.281,256,2.597,257,2.281]],["description/60",[7,0.347,8,0.49,30,2.565,99,1.788,220,2.355,222,2.264,225,2.679,255,2.679,257,2.679,258,3.051,259,3.051,260,3.051,261,3.051,262,3.051,263,3.051,264,3.051]],["title/61",[187,2.957,220,1.714,265,3.52,266,3.52]],["description/61",[7,0.347,8,0.737,17,1.451,47,1.707,59,1.879,77,1.788,140,2.251,187,2.251,220,1.305,265,4.026,266,2.679,267,3.051,268,3.051,269,3.051,270,3.051,271,3.051,272,3.051,273,3.051]],["title/62",[249,4.103]],["description/62",[76,2.244,128,2.666,249,3.867,274,5.606]],["title/63",[17,2.139,65,2.923,249,3.103]],["description/63",[7,0.48,15,1.687,17,2.451,25,2.185,47,1.532,59,1.687,65,1.78,78,1.407,99,1.605,127,2.405,249,3.996,275,2.739,276,2.739,277,2.739,278,2.739,279,2.739,280,2.739,281,2.739]],["title/64",[53,3.056]],["description/64",[]],["title/65",[53,2.632,282,4.086]],["description/65",[53,3.417]],["title/66",[31,2.408,53,2.311,282,3.588]],["description/66",[283,6.65]],["title/67",[40,1.906,53,2.06,132,3.52,282,3.198]],["description/67",[284,6.65]],["title/68",[3,0.272,32,1.336,285,3.52,286,3.52]],["description/68",[3,0.302,7,0.505,8,0.714,13,2.38,32,1.481,40,2.113,285,3.902,286,3.902,287,4.443]],["title/69",[39,2.828]],["description/69",[]],["title/70",[3,0.305,31,2.408,39,2.139]],["description/70",[3,0.186,5,0.26,6,0.913,30,1.532,31,1.467,39,2.008,40,1.303,41,2.745,42,2.405,43,1.89,44,2.405,45,3.116,46,1.605,47,1.532,48,2.405,49,2.185,50,2.185,51,2.021,52,0.913,53,1.407,54,2.405]],["title/71",[3,0.272,5,0.381,39,1.906,80,1.838]],["description/71",[3,0.329,5,0.46,7,0.551,8,0.778,39,2.304,80,2.222,86,4.254]],["title/72",[5,0.381,39,1.906,76,1.605,80,1.838]],["description/72",[5,0.39,7,0.466,8,0.659,39,2.7,76,1.643,80,1.881,87,3.603,88,3.603,89,3.603,90,3.603]],["title/73",[288,3.185]],["description/73",[]],["title/74",[3,0.245,5,0.343,40,1.719,92,2.35,288,1.936]],["description/74",[289,5.839]],["title/75",[3,0.245,10,1.546,11,1.658,40,1.719,288,1.936]],["description/75",[289,5.839]],["title/76",[3,0.223,5,0.313,40,1.566,227,2.028,288,1.763,290,2.891]],["description/76",[291,6.65]],["title/77",[5,0.381,40,1.906,96,2.957,288,2.147]],["description/77",[292,5.305]],["title/78",[40,1.719,56,1.858,203,2.668,288,1.936,293,3.175]],["description/78",[292,5.305]],["title/79",[2,2.627,63,1.51,288,1.763,294,3.293,295,1.93,296,3.293]],["description/79",[292,5.305]],["title/80",[297,5.947]],["description/80",[]],["title/81",[5,0.343,40,1.719,92,2.35,288,1.936,295,2.119]],["description/81",[298,5.839]],["title/82",[10,1.111,62,2.796,92,1.688,288,1.391,295,1.522,299,2.597,300,2.597,301,2.281]],["description/82",[298,5.839]],["title/83",[5,0.313,40,1.566,227,2.028,288,1.763,290,2.891,295,1.93]],["description/83",[302,6.65]],["title/84",[5,0.381,40,1.906,96,2.957,295,2.349]],["description/84",[303,5.305]],["title/85",[40,1.719,56,1.858,203,2.668,293,3.175,295,2.119]],["description/85",[303,5.305]],["title/86",[63,2.348,295,3.001]],["description/86",[303,5.305]],["title/87",[56,1.553,62,3.141,227,1.862,295,1.771,301,2.654,304,3.023]],["description/87",[305,6.65]],["title/88",[52,1.707,68,2.05]],["description/88",[]],["title/89",[3,0.272,5,0.381,52,1.336,68,1.605]],["description/89",[3,0.278,7,0.466,47,2.295,52,1.368,68,1.643,69,3.603,70,3.027,71,4.986,72,2.404,73,3.027]],["title/90",[3,0.245,10,1.546,11,1.658,52,1.205,68,1.448]],["description/90",[3,0.329,7,0.551,10,2.072,11,2.222,52,1.615,68,1.94,73,3.575]],["title/91",[52,1.499,63,2.062,68,1.8]],["description/91",[7,0.605,52,1.776,63,2.443,68,2.133,74,4.678]],["title/92",[75,2.436,76,2.05]],["description/92",[]],["title/93",[3,0.272,5,0.381,75,1.906,76,1.605]],["description/93",[3,0.213,5,0.298,7,0.357,8,0.505,46,1.84,72,1.84,75,2.228,76,1.876,77,1.84,78,2.407,79,3.456,80,1.44,81,2.041,82,2.317,83,2.758]],["title/94",[3,0.245,5,0.343,75,1.719,76,1.448,80,1.658]],["description/94",[3,0.22,5,0.307,7,0.368,8,0.52,46,1.896,72,1.896,75,2.278,76,1.918,77,1.896,78,2.461,79,3.534,81,2.103,82,2.387,84,2.841]],["title/95",[3,0.223,5,0.313,75,1.566,76,1.318,80,1.51,81,2.14]],["description/95",[3,0.25,5,0.35,7,0.418,8,0.591,46,2.156,72,2.156,75,2.501,76,2.106,77,2.156,78,2.703,85,3.231]],["title/96",[91,4.103]],["description/96",[]],["title/97",[3,0.305,5,0.427,91,3.103]],["description/97",[3,0.259,7,0.433,21,2.347,41,2.477,45,2.812,91,3.72,92,2.477,93,3.346,94,1.812,95,3.346,96,2.812,97,3.346]]],"invertedIndex":[["",{"_index":2,"title":{"79":{}},"description":{"0":{},"42":{}}}],["10",{"_index":281,"title":{},"description":{"63":{}}}],["3rd",{"_index":112,"title":{},"description":{"30":{}}}],["404",{"_index":143,"title":{},"description":{"42":{}}}],["429",{"_index":236,"title":{},"description":{"55":{}}}],["503",{"_index":232,"title":{},"description":{"55":{}}}],["access",{"_index":206,"title":{},"description":{"49":{}}}],["add",{"_index":299,"title":{"82":{}},"description":{}}],["addit",{"_index":241,"title":{},"description":{"57":{}}}],["against",{"_index":111,"title":{},"description":{"30":{}}}],["ai",{"_index":270,"title":{},"description":{"61":{}}}],["allow",{"_index":25,"title":{},"description":{"6":{},"58":{},"63":{}}}],["along",{"_index":95,"title":{},"description":{"21":{},"97":{}}}],["analyt",{"_index":196,"title":{"47":{}},"description":{"47":{}}}],["analyz",{"_index":271,"title":{},"description":{"61":{}}}],["apex",{"_index":144,"title":{},"description":{"42":{}}}],["api",{"_index":128,"title":{"51":{},"52":{},"53":{}},"description":{"42":{},"49":{},"50":{},"51":{},"52":{},"53":{},"54":{},"55":{},"57":{},"62":{}}}],["api-key",{"_index":211,"title":{"50":{}},"description":{}}],["applic",{"_index":282,"title":{"65":{},"66":{},"67":{}},"description":{}}],["archiv",{"_index":257,"title":{"60":{}},"description":{"60":{}}}],["array",{"_index":36,"title":{},"description":{"7":{},"28":{},"44":{}}}],["ascend",{"_index":101,"title":{},"description":{"23":{},"24":{},"25":{},"27":{}}}],["assist",{"_index":266,"title":{"61":{}},"description":{"61":{}}}],["associ",{"_index":294,"title":{"79":{}},"description":{}}],["asynchron",{"_index":139,"title":{},"description":{"42":{},"55":{}}}],["attribut",{"_index":293,"title":{"78":{},"85":{}},"description":{}}],["audit",{"_index":32,"title":{"7":{},"12":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"42":{},"68":{}},"description":{"7":{},"12":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"42":{},"68":{}}}],["auditedat",{"_index":34,"title":{},"description":{"7":{},"26":{}}}],["audits/latest/{audittyp",{"_index":103,"title":{},"description":{"23":{}}}],["auth",{"_index":109,"title":{"30":{}},"description":{}}],["auth/google/{siteid",{"_index":118,"title":{},"description":{"31":{}}}],["authent",{"_index":0,"title":{"0":{},"31":{}},"description":{"30":{},"31":{},"51":{},"53":{}}}],["avail",{"_index":50,"title":{},"description":{"8":{},"55":{},"70":{}}}],["base",{"_index":16,"title":{"6":{}},"description":{"6":{},"42":{}}}],["base64",{"_index":23,"title":{},"description":{"6":{}}}],["bodi",{"_index":60,"title":{},"description":{"10":{},"36":{}}}],["bucket",{"_index":79,"title":{},"description":{"16":{},"17":{},"93":{},"94":{}}}],["cdn",{"_index":173,"title":{"45":{}},"description":{"45":{}}}],["channel",{"_index":200,"title":{"49":{}},"description":{"48":{},"49":{}}}],["charact",{"_index":27,"title":{},"description":{"6":{}}}],["choic",{"_index":272,"title":{},"description":{"61":{}}}],["chronolog",{"_index":69,"title":{},"description":{"13":{},"89":{}}}],["client",{"_index":216,"title":{"52":{}},"description":{"52":{},"53":{},"55":{}}}],["code",{"_index":169,"title":{},"description":{"44":{}}}],["command",{"_index":136,"title":{},"description":{"42":{}}}],["complet",{"_index":185,"title":{"47":{}},"description":{"45":{},"46":{},"47":{}}}],["config",{"_index":124,"title":{"40":{}},"description":{"40":{}}}],["configur",{"_index":53,"title":{"12":{},"29":{},"64":{},"65":{},"66":{},"67":{}},"description":{"8":{},"12":{},"29":{},"65":{},"70":{}}}],["configurations/latest",{"_index":283,"title":{},"description":{"66":{}}}],["configurations/sites/audit",{"_index":287,"title":{},"description":{"68":{}}}],["configurations/{vers",{"_index":284,"title":{},"description":{"67":{}}}],["contain",{"_index":262,"title":{},"description":{"60":{}}}],["content",{"_index":221,"title":{},"description":{"54":{}}}],["contract",{"_index":165,"title":{},"description":{"44":{}}}],["creat",{"_index":10,"title":{"3":{},"14":{},"33":{},"51":{},"55":{},"75":{},"82":{},"90":{}},"description":{"3":{},"14":{},"33":{},"51":{},"52":{},"53":{},"57":{},"90":{}}}],["current",{"_index":87,"title":{},"description":{"20":{},"72":{}}}],["custom",{"_index":226,"title":{},"description":{"55":{}}}],["cwv",{"_index":145,"title":{},"description":{"42":{}}}],["data",{"_index":45,"title":{},"description":{"8":{},"21":{},"70":{},"97":{}}}],["date",{"_index":102,"title":{},"description":{"23":{},"24":{},"25":{},"27":{}}}],["delet",{"_index":63,"title":{"11":{},"15":{},"37":{},"53":{},"57":{},"79":{},"86":{},"91":{}},"description":{"11":{},"15":{},"37":{},"53":{},"57":{},"91":{}}}],["deliv",{"_index":159,"title":{},"description":{"44":{}}}],["deliveri",{"_index":12,"title":{"5":{}},"description":{"5":{},"44":{},"54":{}}}],["depend",{"_index":149,"title":{},"description":{"42":{}}}],["deprec",{"_index":129,"title":{},"description":{"42":{}}}],["descend",{"_index":72,"title":{},"description":{"13":{},"16":{},"17":{},"18":{},"89":{},"93":{},"94":{},"95":{}}}],["detail",{"_index":96,"title":{"77":{},"84":{}},"description":{"21":{},"97":{}}}],["determin",{"_index":33,"title":{},"description":{"7":{},"28":{},"42":{}}}],["disabl",{"_index":286,"title":{"68":{}},"description":{"68":{}}}],["discov",{"_index":190,"title":{},"description":{"45":{},"46":{}}}],["discoveri",{"_index":172,"title":{"45":{},"46":{}},"description":{}}],["document",{"_index":258,"title":{},"description":{"60":{}}}],["domain",{"_index":51,"title":{},"description":{"8":{},"45":{},"46":{},"70":{}}}],["download",{"_index":255,"title":{"60":{}},"description":{"60":{}}}],["each",{"_index":268,"title":{},"description":{"61":{}}}],["edg",{"_index":167,"title":{},"description":{"44":{},"54":{}}}],["enabl",{"_index":285,"title":{"68":{}},"description":{"68":{}}}],["encod",{"_index":24,"title":{},"description":{"6":{}}}],["endpoint",{"_index":7,"title":{},"description":{"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"31":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"42":{},"44":{},"45":{},"46":{},"49":{},"51":{},"52":{},"53":{},"55":{},"56":{},"57":{},"58":{},"59":{},"60":{},"61":{},"63":{},"68":{},"71":{},"72":{},"89":{},"90":{},"91":{},"93":{},"94":{},"95":{},"97":{}}}],["enhanc",{"_index":134,"title":{},"description":{"42":{}}}],["entiti",{"_index":240,"title":{},"description":{"57":{}}}],["event",{"_index":68,"title":{"13":{},"14":{},"15":{},"44":{},"47":{},"88":{},"89":{},"90":{},"91":{}},"description":{"13":{},"14":{},"15":{},"43":{},"44":{},"47":{},"89":{},"90":{},"91":{}}}],["event/fulfil",{"_index":170,"title":{},"description":{"44":{}}}],["exampl",{"_index":64,"title":{},"description":{"12":{},"29":{}}}],["exist",{"_index":203,"title":{"49":{},"78":{},"85":{}},"description":{"49":{}}}],["experi",{"_index":91,"title":{"21":{},"96":{},"97":{}},"description":{"21":{},"97":{}}}],["field",{"_index":57,"title":{},"description":{"10":{},"36":{}}}],["file",{"_index":225,"title":{},"description":{"55":{},"60":{}}}],["filter",{"_index":290,"title":{"76":{},"83":{}},"description":{}}],["fix",{"_index":296,"title":{"79":{}},"description":{}}],["flow",{"_index":117,"title":{},"description":{"31":{}}}],["follow",{"_index":142,"title":{},"description":{"42":{}}}],["format",{"_index":155,"title":{},"description":{"44":{}}}],["fulfil",{"_index":157,"title":{},"description":{"44":{}}}],["fulfillment_complet",{"_index":154,"title":{"44":{}},"description":{"44":{}}}],["further",{"_index":248,"title":{},"description":{"58":{}}}],["futur",{"_index":131,"title":{},"description":{"42":{}}}],["gateway",{"_index":158,"title":{},"description":{"44":{}}}],["gener",{"_index":259,"title":{},"description":{"60":{}}}],["geo",{"_index":81,"title":{"18":{},"95":{}},"description":{"16":{},"17":{},"93":{},"94":{}}}],["given",{"_index":94,"title":{"23":{},"25":{},"52":{}},"description":{"21":{},"23":{},"25":{},"28":{},"49":{},"56":{},"57":{},"58":{},"59":{},"97":{}}}],["googl",{"_index":115,"title":{"31":{}},"description":{"31":{}}}],["handl",{"_index":164,"title":{},"description":{"44":{}}}],["header",{"_index":176,"title":{},"description":{"45":{},"51":{},"55":{}}}],["hook",{"_index":150,"title":{"43":{},"45":{},"46":{}},"description":{"45":{},"46":{}}}],["hooks/site-detection/cdn/{hooksecret",{"_index":191,"title":{},"description":{"45":{}}}],["hooks/site-detection/rum/{hooksecret",{"_index":193,"title":{},"description":{"46":{}}}],["hooks/site-integration/analytics/{hooksecret",{"_index":199,"title":{},"description":{"47":{}}}],["hoolihan",{"_index":160,"title":{},"description":{"44":{}}}],["https://github.com/adobe/spacecat-api-service/issues/237",{"_index":198,"title":{},"description":{"47":{}}}],["id",{"_index":20,"title":{"9":{},"35":{},"39":{},"40":{}},"description":{"6":{},"9":{},"35":{},"39":{},"40":{},"42":{},"49":{}}}],["identifi",{"_index":19,"title":{},"description":{"6":{},"26":{}}}],["im",{"_index":120,"title":{"39":{},"40":{},"52":{}},"description":{"39":{},"40":{},"49":{},"53":{}}}],["immedi",{"_index":141,"title":{},"description":{"42":{},"58":{}}}],["implement",{"_index":77,"title":{},"description":{"16":{},"17":{},"18":{},"47":{},"61":{},"93":{},"94":{},"95":{}}}],["import",{"_index":220,"title":{"54":{},"55":{},"56":{},"57":{},"58":{},"59":{},"60":{},"61":{}},"description":{"54":{},"55":{},"56":{},"57":{},"58":{},"59":{},"60":{},"61":{}}}],["import-report.xlsx",{"_index":261,"title":{},"description":{"60":{}}}],["import.j",{"_index":223,"title":{},"description":{"55":{}}}],["imports.delet",{"_index":243,"title":{},"description":{"57":{}}}],["includ",{"_index":30,"title":{"7":{}},"description":{"7":{},"8":{},"28":{},"45":{},"46":{},"51":{},"60":{},"70":{}}}],["incom",{"_index":171,"title":{"45":{},"46":{}},"description":{"45":{},"46":{}}}],["inform",{"_index":192,"title":{},"description":{"46":{}}}],["init",{"_index":110,"title":{},"description":{"30":{}}}],["initi",{"_index":178,"title":{},"description":{"45":{},"46":{}}}],["input",{"_index":278,"title":{},"description":{"63":{}}}],["integr",{"_index":195,"title":{"47":{}},"description":{"47":{}}}],["intend",{"_index":163,"title":{},"description":{"44":{}}}],["invit",{"_index":202,"title":{"49":{}},"description":{"49":{}}}],["involv",{"_index":166,"title":{},"description":{"44":{}}}],["item",{"_index":168,"title":{},"description":{"44":{}}}],["itself",{"_index":242,"title":{},"description":{"57":{}}}],["job",{"_index":222,"title":{"55":{},"56":{},"57":{},"58":{},"59":{},"60":{}},"description":{"55":{},"56":{},"57":{},"58":{},"59":{},"60":{}}}],["jobid",{"_index":239,"title":{},"description":{"56":{},"57":{},"58":{},"59":{}}}],["key",{"_index":52,"title":{"13":{},"14":{},"15":{},"51":{},"52":{},"53":{},"88":{},"89":{},"90":{},"91":{}},"description":{"8":{},"13":{},"14":{},"15":{},"50":{},"51":{},"52":{},"53":{},"55":{},"57":{},"70":{},"89":{},"90":{},"91":{}}}],["latest",{"_index":31,"title":{"7":{},"8":{},"23":{},"28":{},"66":{},"70":{}},"description":{"7":{},"8":{},"28":{},"70":{}}}],["lh",{"_index":146,"title":{},"description":{"42":{}}}],["lhs-desktop",{"_index":147,"title":{},"description":{"42":{}}}],["lhs-mobil",{"_index":148,"title":{},"description":{"42":{}}}],["list",{"_index":92,"title":{"74":{},"81":{},"82":{}},"description":{"21":{},"52":{},"97":{}}}],["log",{"_index":174,"title":{"45":{},"46":{}},"description":{"45":{},"46":{}}}],["longer",{"_index":133,"title":{},"description":{"42":{},"53":{}}}],["make",{"_index":269,"title":{},"description":{"61":{}}}],["manag",{"_index":201,"title":{},"description":{"48":{},"50":{}}}],["mani",{"_index":237,"title":{},"description":{"55":{}}}],["map",{"_index":224,"title":{},"description":{"55":{}}}],["mark",{"_index":217,"title":{},"description":{"53":{},"58":{}}}],["maximum",{"_index":279,"title":{},"description":{"63":{}}}],["messag",{"_index":188,"title":{},"description":{"45":{},"46":{}}}],["metric",{"_index":39,"title":{"8":{},"19":{},"20":{},"69":{},"70":{},"71":{},"72":{}},"description":{"8":{},"19":{},"20":{},"70":{},"71":{},"72":{}}}],["monitor",{"_index":44,"title":{},"description":{"8":{},"70":{}}}],["more",{"_index":300,"title":{"82":{}},"description":{}}],["multipl",{"_index":304,"title":{"87":{}},"description":{}}],["new",{"_index":11,"title":{"3":{},"14":{},"33":{},"51":{},"55":{},"75":{},"90":{}},"description":{"3":{},"14":{},"33":{},"51":{},"55":{},"58":{},"90":{}}}],["note",{"_index":267,"title":{},"description":{"61":{}}}],["notifi",{"_index":189,"title":{},"description":{"45":{},"46":{}}}],["number",{"_index":280,"title":{},"description":{"63":{}}}],["object",{"_index":37,"title":{},"description":{"7":{},"28":{}}}],["obtain",{"_index":93,"title":{},"description":{"21":{},"97":{}}}],["on",{"_index":62,"title":{"82":{},"87":{}},"description":{"10":{},"36":{},"42":{}}}],["on-demand",{"_index":137,"title":{},"description":{"42":{}}}],["onc",{"_index":183,"title":{},"description":{"45":{},"46":{},"51":{}}}],["oper",{"_index":4,"title":{},"description":{"1":{},"22":{},"32":{},"41":{},"57":{},"58":{}}}],["opportun",{"_index":288,"title":{"73":{},"74":{},"75":{},"76":{},"77":{},"78":{},"79":{},"81":{},"82":{},"83":{}},"description":{}}],["opportunity-suggest",{"_index":297,"title":{"80":{}},"description":{}}],["option",{"_index":98,"title":{},"description":{"23":{},"24":{},"25":{},"27":{},"55":{}}}],["order",{"_index":78,"title":{},"description":{"16":{},"17":{},"18":{},"23":{},"24":{},"25":{},"27":{},"63":{},"93":{},"94":{},"95":{}}}],["org",{"_index":121,"title":{"39":{},"40":{}},"description":{"39":{},"40":{},"49":{}}}],["organ",{"_index":6,"title":{"2":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"49":{}},"description":{"2":{},"8":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"49":{},"70":{}}}],["organic-keyword",{"_index":88,"title":{},"description":{"20":{},"72":{}}}],["organization'",{"_index":204,"title":{},"description":{"49":{}}}],["organizations/by-ims-org-id/{imsorgid",{"_index":122,"title":{},"description":{"39":{}}}],["organizations/by-ims-org-id/{imsorgid}/slack-config",{"_index":125,"title":{},"description":{"40":{}}}],["organizations/{organizationid",{"_index":119,"title":{},"description":{"35":{},"36":{},"37":{}}}],["organizations/{organizationid}/sit",{"_index":9,"title":{},"description":{"2":{},"38":{}}}],["otherwis",{"_index":235,"title":{},"description":{"55":{}}}],["own",{"_index":215,"title":{"52":{}},"description":{}}],["page",{"_index":76,"title":{"16":{},"17":{},"18":{},"20":{},"72":{},"92":{},"93":{},"94":{},"95":{}},"description":{"16":{},"17":{},"18":{},"20":{},"62":{},"72":{},"93":{},"94":{},"95":{}}}],["parallel",{"_index":276,"title":{},"description":{"63":{}}}],["paramet",{"_index":28,"title":{},"description":{"6":{},"42":{}}}],["part",{"_index":260,"title":{},"description":{"60":{}}}],["parti",{"_index":113,"title":{},"description":{"30":{}}}],["particular",{"_index":162,"title":{},"description":{"44":{}}}],["patch",{"_index":245,"title":{"58":{}},"description":{}}],["path",{"_index":22,"title":{},"description":{"6":{}}}],["per",{"_index":58,"title":{},"description":{"10":{},"36":{},"55":{}}}],["permit",{"_index":234,"title":{},"description":{"55":{}}}],["pipelin",{"_index":161,"title":{},"description":{"44":{}}}],["pleas",{"_index":135,"title":{},"description":{"42":{}}}],["pre-sign",{"_index":254,"title":{"60":{}},"description":{}}],["prerequisit",{"_index":208,"title":{},"description":{"49":{}}}],["prevent",{"_index":247,"title":{},"description":{"58":{}}}],["proce",{"_index":186,"title":{},"description":{"45":{},"46":{}}}],["procedur",{"_index":182,"title":{},"description":{"45":{},"46":{}}}],["process",{"_index":153,"title":{"44":{},"45":{},"46":{},"47":{}},"description":{"44":{},"45":{},"46":{},"47":{},"55":{}}}],["produc",{"_index":156,"title":{},"description":{"44":{}}}],["progress",{"_index":252,"title":{"59":{}},"description":{"59":{}}}],["prompt",{"_index":265,"title":{"61":{}},"description":{"61":{}}}],["properti",{"_index":35,"title":{},"description":{"7":{},"26":{}}}],["prototyp",{"_index":275,"title":{},"description":{"63":{}}}],["provid",{"_index":21,"title":{},"description":{"6":{},"10":{},"21":{},"36":{},"49":{},"57":{},"97":{}}}],["queri",{"_index":228,"title":{"56":{},"59":{}},"description":{"55":{},"56":{},"59":{}}}],["queue",{"_index":230,"title":{},"description":{"55":{}}}],["read",{"_index":205,"title":{},"description":{"49":{}}}],["real",{"_index":42,"title":{},"description":{"8":{},"70":{}}}],["receiv",{"_index":152,"title":{},"description":{"43":{},"45":{},"46":{}}}],["recent",{"_index":71,"title":{},"description":{"13":{},"89":{}}}],["redirect",{"_index":116,"title":{},"description":{"31":{}}}],["remov",{"_index":130,"title":{},"description":{"42":{},"57":{}}}],["request",{"_index":59,"title":{"49":{},"60":{}},"description":{"10":{},"36":{},"55":{},"61":{},"63":{}}}],["requir",{"_index":244,"title":{},"description":{"57":{}}}],["respons",{"_index":140,"title":{},"description":{"42":{},"51":{},"55":{},"61":{}}}],["result",{"_index":99,"title":{"60":{}},"description":{"23":{},"24":{},"25":{},"27":{},"58":{},"60":{},"63":{}}}],["retriev",{"_index":5,"title":{"2":{},"4":{},"5":{},"6":{},"7":{},"9":{},"13":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"34":{},"35":{},"38":{},"39":{},"40":{},"71":{},"72":{},"74":{},"76":{},"77":{},"81":{},"83":{},"84":{},"89":{},"93":{},"94":{},"95":{},"97":{}},"description":{"2":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"16":{},"17":{},"18":{},"19":{},"20":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"34":{},"35":{},"38":{},"39":{},"40":{},"70":{},"71":{},"72":{},"93":{},"94":{},"95":{}}}],["return",{"_index":47,"title":{},"description":{"8":{},"13":{},"42":{},"51":{},"55":{},"61":{},"63":{},"70":{},"89":{}}}],["rum",{"_index":41,"title":{"46":{}},"description":{"8":{},"21":{},"46":{},"70":{},"97":{}}}],["run",{"_index":138,"title":{},"description":{"42":{}}}],["same",{"_index":277,"title":{},"description":{"63":{}}}],["sanit",{"_index":181,"title":{},"description":{"45":{},"46":{}}}],["save",{"_index":250,"title":{},"description":{"58":{}}}],["schema",{"_index":61,"title":{},"description":{"10":{},"36":{}}}],["scope",{"_index":212,"title":{},"description":{"51":{},"57":{}}}],["scrape",{"_index":249,"title":{"62":{},"63":{}},"description":{"58":{},"62":{},"63":{}}}],["securitydefinit",{"_index":1,"title":{},"description":{"0":{}}}],["send",{"_index":187,"title":{"61":{}},"description":{"45":{},"46":{},"61":{}}}],["sequenc",{"_index":179,"title":{},"description":{"45":{},"46":{}}}],["servic",{"_index":114,"title":{},"description":{"30":{},"44":{},"54":{},"55":{}}}],["set",{"_index":65,"title":{"63":{}},"description":{"12":{},"29":{},"51":{},"55":{},"63":{}}}],["setup",{"_index":194,"title":{"47":{}},"description":{"47":{}}}],["singl",{"_index":15,"title":{"6":{},"9":{},"26":{},"35":{}},"description":{"26":{},"55":{},"63":{}}}],["site",{"_index":3,"title":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"13":{},"14":{},"16":{},"17":{},"18":{},"19":{},"21":{},"24":{},"25":{},"26":{},"27":{},"28":{},"38":{},"45":{},"46":{},"47":{},"68":{},"70":{},"71":{},"74":{},"75":{},"76":{},"89":{},"90":{},"93":{},"94":{},"95":{},"97":{}},"description":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"13":{},"14":{},"16":{},"17":{},"18":{},"19":{},"21":{},"24":{},"25":{},"26":{},"27":{},"28":{},"38":{},"42":{},"47":{},"68":{},"70":{},"71":{},"89":{},"90":{},"93":{},"94":{},"95":{},"97":{}}}],["sites/by-base-url/{base64baseurl",{"_index":29,"title":{},"description":{"6":{}}}],["sites/by-delivery-type/{deliverytyp",{"_index":14,"title":{},"description":{"5":{}}}],["sites/with-latest-audit/{audittyp",{"_index":38,"title":{},"description":{"7":{}}}],["sites/{siteid",{"_index":55,"title":{},"description":{"9":{},"10":{},"11":{}}}],["sites/{siteid}/audit",{"_index":104,"title":{},"description":{"24":{}}}],["sites/{siteid}/audits/latest",{"_index":107,"title":{},"description":{"27":{}}}],["sites/{siteid}/audits/{audittyp",{"_index":105,"title":{},"description":{"25":{}}}],["sites/{siteid}/audits/{audittype}/{auditedat",{"_index":106,"title":{},"description":{"26":{}}}],["sites/{siteid}/experi",{"_index":97,"title":{},"description":{"21":{},"97":{}}}],["sites/{siteid}/key-ev",{"_index":73,"title":{},"description":{"13":{},"14":{},"89":{},"90":{}}}],["sites/{siteid}/key-events/{keyeventid",{"_index":74,"title":{},"description":{"15":{},"91":{}}}],["sites/{siteid}/latest-audit/{audittyp",{"_index":108,"title":{},"description":{"28":{}}}],["sites/{siteid}/latest-metr",{"_index":54,"title":{},"description":{"8":{},"70":{}}}],["sites/{siteid}/metrics/{metric}/{sourc",{"_index":86,"title":{},"description":{"19":{},"71":{}}}],["sites/{siteid}/metrics/{metric}/{source}/by-url/{base64pageurl",{"_index":90,"title":{},"description":{"20":{},"72":{}}}],["sites/{siteid}/opportun",{"_index":289,"title":{},"description":{"74":{},"75":{}}}],["sites/{siteid}/opportunities/by-status/{statu",{"_index":291,"title":{},"description":{"76":{}}}],["sites/{siteid}/opportunities/{opportunityid",{"_index":292,"title":{},"description":{"77":{},"78":{},"79":{}}}],["sites/{siteid}/opportunities/{opportunityid}/suggest",{"_index":298,"title":{},"description":{"81":{},"82":{}}}],["sites/{siteid}/opportunities/{opportunityid}/suggestions/by-status/{statu",{"_index":302,"title":{},"description":{"83":{}}}],["sites/{siteid}/opportunities/{opportunityid}/suggestions/statu",{"_index":305,"title":{},"description":{"87":{}}}],["sites/{siteid}/opportunities/{opportunityid}/suggestions/{suggestionid",{"_index":303,"title":{},"description":{"84":{},"85":{},"86":{}}}],["sites/{siteid}/top-pag",{"_index":83,"title":{},"description":{"16":{},"93":{}}}],["sites/{siteid}/top-pages/{sourc",{"_index":84,"title":{},"description":{"17":{},"94":{}}}],["sites/{siteid}/top-pages/{source}/{geo",{"_index":85,"title":{},"description":{"18":{},"95":{}}}],["sites/{siteid}/{audittyp",{"_index":67,"title":{},"description":{"12":{},"29":{}}}],["skip",{"_index":66,"title":{},"description":{"12":{},"29":{}}}],["slack",{"_index":123,"title":{"40":{},"48":{},"49":{}},"description":{"40":{},"42":{},"45":{},"46":{},"48":{},"49":{}}}],["slack/channels/invite-by-user-id",{"_index":210,"title":{},"description":{"49":{}}}],["sort",{"_index":100,"title":{},"description":{"23":{},"24":{},"25":{},"27":{}}}],["sourc",{"_index":80,"title":{"17":{},"18":{},"19":{},"20":{},"71":{},"72":{},"94":{},"95":{}},"description":{"16":{},"19":{},"20":{},"71":{},"72":{},"93":{}}}],["spacecat",{"_index":209,"title":{},"description":{"49":{},"51":{}}}],["special",{"_index":26,"title":{},"description":{"6":{}}}],["specif",{"_index":40,"title":{"67":{},"74":{},"75":{},"76":{},"77":{},"78":{},"81":{},"83":{},"84":{},"85":{}},"description":{"8":{},"68":{},"70":{}}}],["start",{"_index":70,"title":{},"description":{"13":{},"55":{},"58":{},"89":{}}}],["statu",{"_index":227,"title":{"56":{},"76":{},"83":{},"87":{}},"description":{"55":{},"56":{},"58":{}}}],["stop",{"_index":246,"title":{},"description":{"58":{}}}],["storag",{"_index":251,"title":{},"description":{"58":{}}}],["success",{"_index":184,"title":{},"description":{"45":{},"46":{}}}],["suggest",{"_index":295,"title":{"79":{},"81":{},"82":{},"83":{},"84":{},"85":{},"86":{},"87":{}},"description":{}}],["summari",{"_index":263,"title":{},"description":{"60":{}}}],["support",{"_index":89,"title":{},"description":{"20":{},"72":{}}}],["system",{"_index":218,"title":{},"description":{"53":{}}}],["time",{"_index":231,"title":{},"description":{"55":{}}}],["token",{"_index":207,"title":{},"description":{"49":{}}}],["tools/api-key",{"_index":214,"title":{},"description":{"51":{},"52":{}}}],["tools/api-keys/{apikeyid",{"_index":219,"title":{},"description":{"53":{}}}],["tools/import/assistant/prompt",{"_index":273,"title":{},"description":{"61":{}}}],["tools/import/job",{"_index":238,"title":{},"description":{"55":{}}}],["tools/import/jobs/{jobid",{"_index":229,"title":{},"description":{"55":{},"56":{},"57":{},"58":{}}}],["tools/import/jobs/{jobid}/progress",{"_index":253,"title":{},"description":{"59":{}}}],["tools/import/jobs/{jobid}/result",{"_index":264,"title":{},"description":{"60":{}}}],["top",{"_index":75,"title":{"16":{},"17":{},"18":{},"92":{},"93":{},"94":{},"95":{}},"description":{"16":{},"17":{},"18":{},"93":{},"94":{},"95":{}}}],["traffic",{"_index":46,"title":{},"description":{"8":{},"16":{},"17":{},"18":{},"70":{},"93":{},"94":{},"95":{}}}],["transact",{"_index":301,"title":{"82":{},"87":{}},"description":{}}],["trigger",{"_index":126,"title":{"41":{},"42":{}},"description":{"41":{},"42":{}}}],["type",{"_index":13,"title":{"5":{},"23":{},"25":{}},"description":{"5":{},"23":{},"25":{},"26":{},"28":{},"42":{},"68":{}}}],["unavail",{"_index":233,"title":{},"description":{"55":{}}}],["uniqu",{"_index":18,"title":{},"description":{"6":{}}}],["updat",{"_index":56,"title":{"10":{},"12":{},"29":{},"36":{},"78":{},"85":{},"87":{}},"description":{"10":{},"12":{},"29":{},"36":{}}}],["upon",{"_index":177,"title":{},"description":{"45":{},"46":{}}}],["url",{"_index":17,"title":{"6":{},"60":{},"63":{}},"description":{"6":{},"12":{},"29":{},"42":{},"46":{},"55":{},"57":{},"58":{},"61":{},"63":{}}}],["us",{"_index":8,"title":{},"description":{"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"9":{},"10":{},"11":{},"12":{},"16":{},"17":{},"18":{},"19":{},"20":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"31":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"42":{},"44":{},"49":{},"51":{},"52":{},"53":{},"55":{},"56":{},"57":{},"58":{},"59":{},"60":{},"61":{},"68":{},"71":{},"72":{},"93":{},"94":{},"95":{}}}],["user",{"_index":43,"title":{},"description":{"8":{},"31":{},"49":{},"58":{},"70":{}}}],["valid",{"_index":180,"title":{},"description":{"45":{},"46":{},"53":{}}}],["valu",{"_index":49,"title":{},"description":{"8":{},"45":{},"70":{}}}],["version",{"_index":132,"title":{"67":{}},"description":{"42":{}}}],["via",{"_index":197,"title":{},"description":{"47":{},"49":{}}}],["warn",{"_index":127,"title":{},"description":{"42":{},"63":{}}}],["web",{"_index":274,"title":{},"description":{"62":{}}}],["webhook",{"_index":151,"title":{},"description":{"43":{},"45":{},"46":{}}}],["within",{"_index":82,"title":{},"description":{"16":{},"17":{},"93":{},"94":{}}}],["x-api-key",{"_index":213,"title":{},"description":{"51":{}}}],["x-forwarded-host",{"_index":175,"title":{},"description":{"45":{}}}],["zero",{"_index":48,"title":{},"description":{"8":{},"70":{}}}],["zip",{"_index":256,"title":{"60":{}},"description":{}}]],"pipeline":[]}},"options":{"hideRequestPayloadSample":false}};
 
       var container = document.getElementById('redoc');
       Redoc.hydrate(__redoc_state, container);
diff --git a/docs/openapi/parameters.yaml b/docs/openapi/parameters.yaml
index 19163028..20fc9704 100644
--- a/docs/openapi/parameters.yaml
+++ b/docs/openapi/parameters.yaml
@@ -101,6 +101,7 @@ source:
     type: string
     enum:
       - 'ahrefs'
+      - 'google'
     example: 'ahrefs'
 geo:
   name: geo
@@ -119,6 +120,7 @@ metric:
     type: string
     enum:
       - 'organic-traffic'
+      - 'organic-keywords'
     example: 'organic-traffic'
 jobId:
   name: jobId
diff --git a/docs/openapi/site-metrics-api.yaml b/docs/openapi/site-metrics-api.yaml
index 588f1bd3..052dc828 100644
--- a/docs/openapi/site-metrics-api.yaml
+++ b/docs/openapi/site-metrics-api.yaml
@@ -40,7 +40,8 @@ page-metrics-by-source:
       - site
     summary: Retrieve page metrics by source
     description: |
-      This endpoint is useful for retrieving page metrics by source
+      This endpoint is useful for retrieving page metrics by source.
+      Currently only `organic-keywords` is supported as a metric and only for source `ahrefs`.
     operationId: getPageMetricsBySource
     responses:
       '200':