> ## Documentation Index
> Fetch the complete documentation index at: https://docs.upstackdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Auto-Captured Fields

> What Upstack captures for you on browser events: click IDs, UTM parameters, page context, device and location. Do not send these yourself.

These fields are captured automatically by Upstack. Don't include them in your `track()` calls.

## Sample payload

The pixel captures these for you. If you send events from your server, send them yourself in the [Events API](https://docs.upstackdata.com/api-reference/events/send-events-via-upstack-conversion-api.md). Sample with every field you can send:

```json theme={null}
{
  "events": [{
    "name": "purchase",
    "ipAddress": "203.0.113.5",
    "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 18_0 like Mac OS X)",
    "locale": "en-US",
    "timezone": "America/Chicago",
    "page": {
      "host": "www.example.com",
      "path": "/products/classic-tee",
      "referrer": "https://www.google.com/",
      "search": "?utm_source=facebook",
      "title": "Classic Cotton Tee",
      "url": "https://www.example.com/products/classic-tee?utm_source=facebook"
    },
    "campaign": {
      "campaign": "summer_sale",
      "source": "facebook",
      "medium": "paid",
      "term": "ad_set_1",
      "content": "ad_1"
    },
    "click": {
      "fbc": "fb.1.1708271400.AbC123",
      "fbp": "fb.1.1708271400.XyZ789",
      "fbclid": "IwAR0abc",
      "gclid": "Cj0KCQiA",
      "gbraid": "0AAAAAgb",
      "wbraid": "CLKwabc",
      "ttclid": "E.C.P.abc",
      "ttp": "ttp_abc",
      "snapchatSCCid": "scc_abc",
      "snapchatSCCookie": "scid_abc",
      "pinterestEpik": "epik_abc",
      "applovinAxwrt": "axwrt_abc",
      "aleid": "aleid_abc",
      "kx": "kx_abc",
      "klaviyoCid": "kcid_abc",
      "sendlaneCid": "slcid_abc",
      "omnisendCid": "oscid_abc",
      "redditCid": "rdt_abc",
      "redditUuid": "rdtuuid_abc",
      "tblci": "tblci_abc",
      "obclid": "obclid_abc",
      "nbclid": "nbclid_abc",
      "liFatId": "lifat_abc",
      "msclkid": "msclkid_abc"
    },
    "viewport": {
      "viewportWidth": 390,
      "viewportHeight": 844,
      "pageHeight": 3200,
      "devicePixelRatio": 3
    }
  }]
}
```

## Click IDs

Click IDs are captured automatically from URL parameters and browser cookies. Each platform's click ID is stored along with a timestamp indicating when it was collected.

### Meta (Facebook/Instagram)

| Field | Source | Description |
| - | - | - |
| `fbc` | `_fbc` cookie | Meta click ID cookie (contains `fbclid` from ad click URL) |
| `fbp` | `_fbp` cookie | Meta browser ID (first-party cookie for user identification) |
| `fbclid` | URL parameter | Meta click ID from ad click URL (raw parameter value) |

### Google Ads

| Field | Source | Description |
| - | - | - |
| `gclid` | URL parameter | Google click ID (standard web campaigns) |
| `gbraid` | URL parameter | Google click ID for iOS App campaigns (privacy-safe) |
| `wbraid` | URL parameter | Google click ID for web-to-app measurement |

### TikTok

| Field | Source | Description |
| - | - | - |
| `ttclid` | URL parameter | TikTok click ID from ad click URL |
| `ttp` | `_ttp` cookie | TikTok browser ID cookie (first-party pixel cookie) |

### Snapchat

| Field | Source | Description |
| - | - | - |
| `snapchatSCCid` | URL parameter | Snapchat click ID (`ScCid` parameter) |
| `snapchatSCCookie` | `_scid` cookie | Snapchat browser ID cookie |

### Pinterest

| Field | Source | Description |
| - | - | - |
| `pinterestEpik` | `_epik` cookie | Pinterest click ID cookie (Enhanced Match) |

### AppLovin

| Field | Source | Description |
| - | - | - |
| `applovinAxwrt` | URL parameter | AppLovin attribution token (`axwrt` parameter) |
| `aleid` | URL parameter | AppLovin click ID |

### Klaviyo

| Field | Source | Description |
| - | - | - |
| `kx` | URL parameter | Klaviyo click ID from email links |
| `klaviyoCid` | URL parameter | Klaviyo campaign ID |

### Sendlane

| Field | Source | Description |
| - | - | - |
| `sendlaneCid` | URL parameter | Sendlane click ID from email links |

### Omnisend

| Field | Source | Description |
| - | - | - |
| `omnisendCid` | URL parameter | Omnisend click ID from email links |

### Reddit

| Field | Source | Description |
| - | - | - |
| `redditCid` | URL parameter | Reddit click ID from ad clicks |
| `redditUuid` | `_rdt_uuid` cookie | Reddit browser ID cookie |

### Taboola

| Field | Source | Description |
| - | - | - |
| `tblci` | URL parameter | Taboola click ID from native ad clicks |

### Outbrain

| Field | Source | Description |
| - | - | - |
| `obclid` | URL parameter | Outbrain click ID from native ad clicks |

### NewsBreak

| Field | Source | Description |
| - | - | - |
| `nbclid` | URL parameter | NewsBreak click ID from ad clicks |

### LinkedIn

| Field | Source | Description |
| - | - | - |
| `liFatId` | URL parameter | LinkedIn First-Party Ad Tracking ID (`li_fat_id` parameter) |

### Microsoft Advertising (Bing)

| Field | Source | Description |
| - | - | - |
| `msclkid` | URL parameter | Microsoft Advertising click ID |

***

## UTM Parameters

Captured automatically from URL query string parameters:

| Field | Description |
| - | - |
| `utm_source` | Traffic source (e.g., `google`, `facebook`, `newsletter`) |
| `utm_medium` | Marketing medium (e.g., `paid`, `email`, `social`). Upstack counts Meta, TikTok, Pinterest, Snapchat, and Google visits as paid when this is exactly `paid` |
| `utm_campaign` | Campaign name or identifier |
| `utm_content` | Ad name (or ad ID) — shown as **Ad** in attribution reports |
| `utm_term` | Ad set or ad group name (or ID) — shown as **Ad Set** in attribution reports |

***

## Page Context

Captured automatically from the browser on every event:

| Field | Description |
| - | - |
| `host` | Hostname of the page (e.g., `www.example.com`) |
| `path` | URL path (e.g., `/products/widget`) |
| `referrer` | Full referrer URL |
| `search` | Query string (e.g., `?utm_source=google`) |
| `title` | Page title from `document.title` |
| `url` | Full page URL where the event fired |

***

## Viewport & Device

Captured from the browser at page load:

| Field | Description |
| - | - |
| `viewportWidth` | Browser viewport width in CSS pixels |
| `viewportHeight` | Browser viewport height in CSS pixels |
| `pageHeight` | Total scrollable page height in CSS pixels |
| `devicePixelRatio` | Device pixel ratio (e.g., `2` for Retina displays) |
| `device_type` | Detected device type: `"mobile"`, `"desktop"`, or `"tablet"` |
| `client_user_agent` | Browser user agent string |

***

## Browser Settings

| Field | Description |
| - | - |
| `locale` | Browser locale (e.g., `en-US`) |
| `timezone` | Browser timezone (e.g., `America/New_York`) |
| `adBlockDetected` | `true` if an ad blocker was detected |

***

## Location

Captured from the visitor's IP address:

| Field | Description |
| - | - |
| `country` | ISO 3166-1 alpha-2 country code (e.g., `US`, `GB`) |
| `region` | State/province name (e.g., `Texas`, `California`) |
| `regionCode` | ISO 3166-2 region code (e.g., `TX`, `CA`) |
| `city` | City name (e.g., `Austin`, `San Francisco`) |
| `postalCode` | Postal/zip code (e.g., `78701`) |
| `latitude` | Latitude coordinate |
| `longitude` | Longitude coordinate |
| `continent` | Continent code (e.g., `NA`, `EU`, `AS`) |
| `isEUCountry` | `"1"` if the country is in the EU |
| `timezone` | IANA timezone (e.g., `America/Chicago`) |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.