Skip to content

Configuration ​

The serializable client options, the script tag attributes and the GTM template fields come from one schema in packages/contracts/schemas/client/config.v1.schema.json. beforeSend, the event ID generator and the adapter settings are client options outside the schema. The script packages/client/scripts/config.ts makes this page. Do not change it by hand.

OptionScript attributeTypeDefaultRangeDescription
keydata-keystringRequiredpattern ^lg-(pub|sec)-(live|test)-[0-9a-f]{8,}-[0-9a-f]{8}$Publishable key in a browser, or secret key on a server. The key gives the source.
endpointdata-endpointstring"https://in.quickpipe.ai"Ingest URL. A path on the site, for example /_lg, sends the events through the origin of the page.
pageviewsdata-pageviewsbooleantrueSends page.viewed on load and on each route change of a single page app. The script attribute takes on or off.
utmdata-utmbooleantrueReads the UTM parameters, the ad click IDs and qp_t on the first page of a session. The ad click IDs are gclid, gbraid, wbraid, fbclid, li_fat_id, msclkid, ttclid, twclid and rdt_cid. The script attribute takes on or off.
attributesdata-attributesbooleantrueSends the events that data-lg attributes declare on page elements. The script attribute takes on or off.
formsdata-formson, off, no-identify"on"Sends form submits. no-identify sends the events but does not find identifiers in the fields.
datalayerdata-datalayerbooleantrueSends the events of the GTM dataLayer. The script attribute takes on or off.
datalayerIncludedata-datalayer-includestring""pattern ^$|^[A-Za-z0-9_.:\-*]{1,100}(,[A-Za-z0-9_.:\-*]{1,100})*$Sends only the dataLayer events whose name matches a pattern. The value is a list of names with a comma between them, for example generate_lead,purchase*. A * matches each character at its position. The default is empty, which sends each name that the exclude list does not stop. The gtm.* names stay stopped.
datalayerExcludedata-datalayer-excludestring""pattern ^$|^[A-Za-z0-9_.:\-*]{1,100}(,[A-Za-z0-9_.:\-*]{1,100})*$Stops the dataLayer events whose name matches a pattern. The value is a list of names with a comma between them, for example purchase,signup*. A * matches each character at its position. The exclude list wins over the include list.
datalayerEmailKeydata-datalayer-email-keystring"user_data.email"pattern ^$|^[A-Za-z0-9_]+(\.[A-Za-z0-9_]+)*$Key of the email in a dataLayer entry. The client sends an identify with the value when the site grants analytics. The default is user_data.email. An empty value stops the identify from this key.
datalayerUserIdKeydata-datalayer-user-id-keystring"user_id"pattern ^$|^[A-Za-z0-9_]+(\.[A-Za-z0-9_]+)*$Key of the product user ID in a dataLayer entry. The client sends an identify with the value when the site grants analytics. The default is user_id. An empty value stops the identify from this key.
consentdata-consentauto, manual"auto"auto reads Consent Mode v2 from the dataLayer. manual waits for a consent call.
clicksdata-clickson, off, all"all"all sends each click. on sends only outbound link and file download clicks. off sends no clicks.
scrolldata-scrollbooleantrueSends scroll depth at 25, 50, 75 and 100 percent. The script attribute takes on or off.
sample.clicksdata-sample-clicksnumber0.1minimum 0.01, maximum 1Part of the sessions that send element.clicked. The SDK selects each session one time.
adaptersdata-adaptersstring"on"pattern ^(on|off|-[a-z0-9-]{1,40}(,-[a-z0-9-]{1,40})*)$Loads the adapters of the vendors on the page. on loads all adapters, off loads none, and a list with a minus sign before each name excludes those adapters, for example -typeform,-intercom. An adapter name cannot be the name of a top-level option.
transportdata-transportbeacon, fetch"beacon"Transport for the last batch when the page closes.
storagedata-storagelocalStorage, memory, none"localStorage"Store of the offline queue.
batch.sizedata-batch-sizeinteger20minimum 1, maximum 500Events in one batch.
batch.intervaldata-batch-intervalinteger5000minimum 100, maximum 60000Milliseconds between two batches.
queue.maxdata-queue-maxinteger1000minimum 0, maximum 10000Events in the offline queue.
retry.basedata-retry-baseinteger1000minimum 100First retry delay in milliseconds. Each retry doubles it, with jitter.
retry.maxdata-retry-maxinteger300000minimum 1000Largest retry delay in milliseconds.
session.timeoutdata-session-timeoutinteger1800000minimum 60000Milliseconds without activity before the UTM values and the ad click IDs of the session expire.