latestOpenAPI 3.1.0Proprietary - UrbanFox2026-08-101443106.2 KB

e99fd9028c60

Snippet

Get integration snippets

Retrieve integration snippets and identifiers for a tenant.

get/v2/{tenant_slug}/snippet

Path parameters

tenant_slugstring required

Tenant DNS slug (lowercase letters, digits, and hyphens; 3-100 characters).

Example:demo-retail

Tenant DNS slug (lowercase letters, digits, and hyphens; 3-100 characters).

Response

Successful Response

Example response

{
  "data": {
    "snippets": [
      {
        "framework": "HTML",
        "snippet": "<script src=\"https://cdn.example.com/clickstream-web.min.js\"></script>\n<script>\n    window.ClickstreamAnalytics.init({\n        appId: \"demo-retail_00000000000000000000000000000001\",\n        endpoint: \"https://collector.example.com\",\n        globalAttributes: {\n          tenant_id: \"00000000-0000-4000-8000-000000000000\"\n        }\n    })\n</script>"
      }
    ],
    "tenant_name": "demo-retail",
    "app_id": "demo-retail_00000000000000000000000000000001",
    "tenant_id": "00000000-0000-4000-8000-000000000000"
  }
}