Web integrations

Store verification codes and measurement IDs on the website. Once the site is active (not preview), the public layout injects the matching meta tags and scripts. Configure in the admin settings UI, or via API/MCP as website superadmin. PUT fully replaces the integration map, omit a key or send an empty string to clear it.

Read integrations. available is false while the website is in preview (tags are not usable until the site is subscribed/active). Response shape: available, status, integrations.

GET /api/v1/{locale}/{websiteId}/web-integrations

Replace all integration IDs (website superadmin). Forbidden while status is preview.

PUT /api/v1/{locale}/{websiteId}/web-integrations

{
  "googleSearchConsoleVerification": "string?",
  "bingWebmasterVerification": "string?",
  "googleAnalytics4MeasurementId": "G-XXXXXXXX?",
  "googleTagManagerContainerId": "GTM-XXXXXXX?",
  "googleAdsConversionId": "AW-XXXXXXXXX?",
  "metaDomainVerification": "string?",
  "metaPixelId": "string?",
  "microsoftClarityProjectId": "string?",
  "microsoftAdvertisingUetTagId": "string?",
  "tiktokPixelId": "string?",
  "linkedinInsightPartnerId": "string?",
  "pinterestVerificationCode": "string?",
  "pinterestTagId": "string?",
  "hotjarSiteId": "string?"
}

MCP: get_web_integrations, update_web_integrations.

Supported fields

Each field is an optional string token. Invalid formats are rejected on write. Verification fields become HTML meta tags; measurement IDs become third-party scripts on the public site.

• googleSearchConsoleVerification: Google Search Console HTML tag verification token (content value for the google-site-verification meta tag).
• bingWebmasterVerification: Bing Webmaster Tools verification token (msvalidate.01 meta tag).
• googleAnalytics4MeasurementId: GA4 measurement ID (G-…). Loads gtag.js and configures the GA4 stream.
• googleTagManagerContainerId: GTM container ID (GTM-…). Injects the GTM bootstrap script only on verified custom domains when the site is active, not on platform path-prefix URLs.
• googleAdsConversionId: Google Ads conversion ID (AW-…). Uses gtag alongside or instead of GA4 when set.
• metaDomainVerification: Meta (Facebook) domain verification code (facebook-domain-verification meta tag).
• metaPixelId: Meta Pixel ID (numeric). Injects the Meta Pixel base script.
• microsoftClarityProjectId: Microsoft Clarity project ID. Injects the Clarity tracking script.
• microsoftAdvertisingUetTagId: Microsoft Advertising UET tag ID. Injects the Bing UET script.
• tiktokPixelId: TikTok Pixel ID. Injects the TikTok analytics pixel.
• linkedinInsightPartnerId: LinkedIn Insight Tag partner ID (numeric). Injects the LinkedIn insight script.
• pinterestVerificationCode: Pinterest domain verification code (p:domain_verify meta tag).
• pinterestTagId: Pinterest Tag ID. Injects the Pinterest tag script.
• hotjarSiteId: Hotjar site ID (numeric). Injects the Hotjar tracking script.

When tags run

No integration scripts or verification meta tags are served while the website is in preview or otherwise not active. After the site is active, tags inject on path-prefix and custom-domain public URLs only after the visitor accepts cookies (use button consent mode or your own flow). Google Tag Manager injects only on verified custom domains (not on platform path-prefix preview hosts).