X Pixel (Twitter Pixel)

X Pixel (formerly Twitter Pixel) is X's conversion tracking and audience building tool. It helps you measure ad performance, retarget website visitors, and optimize campaigns on the X platform. By default, c15t loads this script based on marketing consent.

Implementation

Info

See the integration overview for how to pass scripts to your framework (JavaScript, React, or Next.js).

import { xPixel } from '@c15t/scripts/x-pixel';

xPixel({
  id: '123456789012345',
});

xPixelEvent

You can use the xPixelEvent function to track events. This is a wrapper around the twq function that the X Pixel script uses.

import { xPixelEvent } from '@c15t/scripts/x-pixel';

xPixelEvent('tw-xxxx-xxxx', { value: 10.0, currency: 'USD' });

Types

XPixelOptions

Property

Types

Loading…

Script

Property

Types

Loading…

XPixelEvent

Property

Types

Loading…

XPixelContent

Property

Types

Loading…

X Pixel (Twitter Pixel)

Implementation

xPixelEvent

Types

XPixelOptions

pixelIdYour X Pixel IDrequiredstring

script?Override or extend the default script values. Default values: id: 'x-pixel' src: https://static.ads-twitter.com/uwt.js category: 'marketing' Partial<Script>

Script

anonymizeId?Whether to use an anonymized ID for the script element, this helps ensure the script is not blocked by ad blockersboolean | undefined

async?Whether to use async loadingboolean | undefined

attributes?Additional attributes to add to the script elementRecord<string, string>

categoryConsent category or condition required to load this scriptrequiredHasCondition<AllConsentNames>

defer?Whether to defer script loadingboolean | undefined

fetchPriority?Priority hint for browser resource loading"high" | "low" | "auto" | undefined

iabLegIntPurposes?IAB TCF legitimate interest purpose IDs. These purposes can operate under legitimate interest instead of consent. The script loads if all iabPurposes have consent OR all iabLegIntPurposes have legitimate interest established.{} | undefined

iabPurposes?IAB TCF purpose IDs this script requires consent for. When in IAB mode and no vendorId is set, the script will only load if ALL specified purposes have consent.{} | undefined

iabSpecialFeatures?IAB TCF special feature IDs this script requires. Special features require explicit opt-in: 1: Use precise geolocation data 2: Actively scan device characteristics for identification {} | undefined

idUnique identifier for the scriptrequiredstring

nonce?Content Security Policy noncestring | undefined

onBeforeLoad?Callback executed before the script is loaded((info: ScriptCallbackInfo) => void) | u...

onConsentChange?Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.((info: ScriptCallbackInfo) => void) | u...

onError?Callback executed if the script fails to load((info: ScriptCallbackInfo) => void) | u...

onLoad?Callback executed when the script loads successfully((info: ScriptCallbackInfo) => void) | u...

persistAfterConsentRevoked?Whether the script should persist after consent is revoked.boolean | undefined

src?URL of the script to loadstring | undefined

textContent?Inline JavaScript code to executestring | undefined

vendorId?IAB TCF vendor ID - links script to a registered vendor. When in IAB mode, the script will only load if this vendor has consent. Takes precedence over category when in IAB mode. Use custom vendor IDs (string or number) to gate non-IAB vendors too.string | number | undefined

XPixelEvent

contents?Content/products associated with the conversion event{} | undefined

conversion_id?Unique identifier for the event that can be used for deduplication purposesstring | undefined

currency?Currency of the conversion event ISO 4217 code (ex: USD, EUR, JPY, etc.)string | undefined

description?Description of the conversion eventstring | undefined

search_string?Search string of the conversion eventstring | undefined

status?Status of the conversion eventboolean | undefined

twclid?twclid of the conversion event The X Pixel already automatically passes twclid from URL or first-party cookie. This parameter can be optionally used to force attribution to a certain ad click.string | undefined

value?Total value of the conversion event (ex: $ value of the transaction in case of a purchase, etc.)number | undefined

XPixelContent

content_group_id?ID associated with a group of product variantsstring | undefined

content_idID of the content For product catalog users: please pass SKU For all other users: Please pass Global Trade Item Number (GTIN) if available, otherwise pass SKUrequiredstring

content_name?Name of a product or servicestring | undefined

content_price?Price of a product or servicenumber | undefined

content_type?Type of the contentstring | undefinedlink

num_items?Quantity of the contentnumber | undefined

pixelIdYour X Pixel IDrequiredstring

script?Override or extend the default script values. Default values: id: 'x-pixel' src: https://static.ads-twitter.com/uwt.js category: 'marketing' Partial<Script>

anonymizeId?Whether to use an anonymized ID for the script element, this helps ensure the script is not blocked by ad blockersboolean | undefined

async?Whether to use async loadingboolean | undefined

attributes?Additional attributes to add to the script elementRecord<string, string>

categoryConsent category or condition required to load this scriptrequiredHasCondition<AllConsentNames>

defer?Whether to defer script loadingboolean | undefined

fetchPriority?Priority hint for browser resource loading"high" | "low" | "auto" | undefined

iabLegIntPurposes?IAB TCF legitimate interest purpose IDs. These purposes can operate under legitimate interest instead of consent. The script loads if all iabPurposes have consent OR all iabLegIntPurposes have legitimate interest established.{} | undefined

iabPurposes?IAB TCF purpose IDs this script requires consent for. When in IAB mode and no vendorId is set, the script will only load if ALL specified purposes have consent.{} | undefined

iabSpecialFeatures?IAB TCF special feature IDs this script requires. Special features require explicit opt-in: 1: Use precise geolocation data 2: Actively scan device characteristics for identification {} | undefined

idUnique identifier for the scriptrequiredstring

nonce?Content Security Policy noncestring | undefined

onBeforeLoad?Callback executed before the script is loaded((info: ScriptCallbackInfo) => void) | u...

onConsentChange?Callback executed whenever the consent store is changed. This callback only applies to scripts already loaded.((info: ScriptCallbackInfo) => void) | u...

onError?Callback executed if the script fails to load((info: ScriptCallbackInfo) => void) | u...

onLoad?Callback executed when the script loads successfully((info: ScriptCallbackInfo) => void) | u...

persistAfterConsentRevoked?Whether the script should persist after consent is revoked.boolean | undefined

src?URL of the script to loadstring | undefined

textContent?Inline JavaScript code to executestring | undefined

vendorId?IAB TCF vendor ID - links script to a registered vendor. When in IAB mode, the script will only load if this vendor has consent. Takes precedence over category when in IAB mode. Use custom vendor IDs (string or number) to gate non-IAB vendors too.string | number | undefined

contents?Content/products associated with the conversion event{} | undefined

conversion_id?Unique identifier for the event that can be used for deduplication purposesstring | undefined

currency?Currency of the conversion event ISO 4217 code (ex: USD, EUR, JPY, etc.)string | undefined

description?Description of the conversion eventstring | undefined

search_string?Search string of the conversion eventstring | undefined

status?Status of the conversion eventboolean | undefined

twclid?twclid of the conversion event The X Pixel already automatically passes twclid from URL or first-party cookie. This parameter can be optionally used to force attribution to a certain ad click.string | undefined

value?Total value of the conversion event (ex: $ value of the transaction in case of a purchase, etc.)number | undefined

content_group_id?ID associated with a group of product variantsstring | undefined

content_idID of the content For product catalog users: please pass SKU For all other users: Please pass Global Trade Item Number (GTIN) if available, otherwise pass SKUrequiredstring

content_name?Name of a product or servicestring | undefined

content_price?Price of a product or servicenumber | undefined

content_type?Type of the contentstring | undefinedlink

num_items?Quantity of the contentnumber | undefined

consentsThe current consent staterequiredRecord<AllConsentNames, boolean>

element?The script element (for load/error callbacks) Will be undefined for callback-only scriptsHTMLScriptElement