Install

Install snippet

The exact tag and steps for a platform. The site (project) ID is public and the snippet holds no secret.

Required token scopes are listed in x-hootlens-scopes. A signed-in person needs the matching permission on the site instead (the viewer and editor roles are presets of the permissions).

get/v1/projects/{projectId}/install-snippet

Request

  • Base URL: https://hootlens-api-368877148687.us-east1.run.app
  • URL: https://hootlens-api-368877148687.us-east1.run.app/v1/projects/{projectId}/install-snippet
  • Auth: HTTP bearer

Path parameters

projectIdstring required

An identifier: 1 to 80 letters, digits, underscores or hyphens.

The project ID. Project IDs are public identifiers, not secrets.

Query parameters

platform'gtm' | 'wordpress' | 'shopify' | 'nextjs' | 'remix' | 'nuxt' | 'sveltekit' | 'astro' | 'angular' | 'gatsby' | 'vite' | 'webflow' | 'squarespace' | 'wix' | 'html'

Site platform. Defaults to html, the raw tag.

variant'app' | 'pages'

For nextjs: app (App Router) or pages (Pages Router).

Response

The snippet and steps.

projectIdstring required

An identifier: 1 to 80 letters, digits, underscores or hyphens.

platformstring required
labelstring
wherestring
tagstring required

The script tag.

variantsobject[]
variantstring
stepsstring[] required
allowedOriginsstring[]
verifystring[]
platformsstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.