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.
| Option | Script attribute | Type | Default | Range | Description |
|---|---|---|---|---|---|
key | data-key | string | Required | pattern ^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. |
endpoint | data-endpoint | string | "https://in.quickpipe.ai" | Ingest URL. A path on the site, for example /_lg, sends the events through the origin of the page. | |
pageviews | data-pageviews | boolean | true | Sends page.viewed on load and on each route change of a single page app. The script attribute takes on or off. | |
utm | data-utm | boolean | true | Reads 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. | |
attributes | data-attributes | boolean | true | Sends the events that data-lg attributes declare on page elements. The script attribute takes on or off. | |
forms | data-forms | on, off, no-identify | "on" | Sends form submits. no-identify sends the events but does not find identifiers in the fields. | |
datalayer | data-datalayer | boolean | true | Sends the events of the GTM dataLayer. The script attribute takes on or off. | |
datalayerInclude | data-datalayer-include | string | "" | 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. |
datalayerExclude | data-datalayer-exclude | string | "" | 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. |
datalayerEmailKey | data-datalayer-email-key | string | "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. |
datalayerUserIdKey | data-datalayer-user-id-key | string | "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. |
consent | data-consent | auto, manual | "auto" | auto reads Consent Mode v2 from the dataLayer. manual waits for a consent call. | |
clicks | data-clicks | on, off, all | "all" | all sends each click. on sends only outbound link and file download clicks. off sends no clicks. | |
scroll | data-scroll | boolean | true | Sends scroll depth at 25, 50, 75 and 100 percent. The script attribute takes on or off. | |
sample.clicks | data-sample-clicks | number | 0.1 | minimum 0.01, maximum 1 | Part of the sessions that send element.clicked. The SDK selects each session one time. |
adapters | data-adapters | string | "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. |
transport | data-transport | beacon, fetch | "beacon" | Transport for the last batch when the page closes. | |
storage | data-storage | localStorage, memory, none | "localStorage" | Store of the offline queue. | |
batch.size | data-batch-size | integer | 20 | minimum 1, maximum 500 | Events in one batch. |
batch.interval | data-batch-interval | integer | 5000 | minimum 100, maximum 60000 | Milliseconds between two batches. |
queue.max | data-queue-max | integer | 1000 | minimum 0, maximum 10000 | Events in the offline queue. |
retry.base | data-retry-base | integer | 1000 | minimum 100 | First retry delay in milliseconds. Each retry doubles it, with jitter. |
retry.max | data-retry-max | integer | 300000 | minimum 1000 | Largest retry delay in milliseconds. |
session.timeout | data-session-timeout | integer | 1800000 | minimum 60000 | Milliseconds without activity before the UTM values and the ad click IDs of the session expire. |