API

This section is intended for developers utilizing our APIs to add channels.

Below you will find the keys to generate secret payloads for adding or updating a channel via the Script API.

Refer to the onboarding page for detailed information on the purpose and usage of each input.

CLARITAS_PIXEL_ID

Use for storing the Pixel ID that identifies your specific tracking pixel within the Claritas platform. This ID determines where your event data should be sent for processing.

Example value

23765

Type TEXT

Optional false

CLARITAS_CONVERSIONS

Use for storing the event mapping configuration as a stringified JSON object. Each key represents an EdgeTag event name, and each value is an object containing the event name and gid (goal ID) for Claritas.

Example value

{"Purchase":{"event":"claritas_purchase","gid":1},"AddToCart":{"event":"claritas_add_to_cart","gid":2},"PageView":{"event":"claritas_page_view","gid":3}}

Value Structure:

• Array of arrays format: [[edgeTagEvent, claritasEvent], [edgeTagEvent, claritasEvent]]
• First element: EdgeTag event name (string)
• Second element: Claritas event name (string)
• Must be stringified when stored as a secret

Type TEXT

Optional false