Web Tracking Keys

Create a web tracking key

Changed on

Creates a publishable key for the browser tracking SDK and returns the script tag to install. The key ships in page source by design and authorizes storefront events only, never the rest of the API. Events start flowing once the snippet is deployed and nothing is backfilled for the period before that. Always pass allowedOrigins for a website or allowedAppIds for an iOS or Android app - a key with neither accepts events from any site or app. Requires the integrations:manage scope.

post/web-tracking-keys

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/web-tracking-keys
  • Auth
    HTTP bearer

Request body

namestring required

Human-readable label, e.g. Storefront.

allowedOriginsstring[]

Origins allowed to use this key. A bare domain is read as https. A leading *. matches subdomains at any depth but not the apex. Omitting this and allowedAppIds leaves the key unrestricted.

allowedAppIdsstring[]

iOS bundle IDs and Android package names allowed to use this key from the mobile SDKs, e.g. com.example.app. Duplicates are dropped case-insensitively.

Response

Key created

successboolean
messagestring

Changes

  • 54f67ac2d016Revision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

  • db3873ca3d4dRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status