---
title: "Request Parameters"
slug: "request-parameters-data-object-php-library-s2s"
description: "Reference of the query parameters the PHP Library sends to Mapp Intelligence, incl. Engage registration fields er1 to er10, with types and examples. "
status: "update"
updated: 2026-11-02T16:59:39Z
published: 2026-11-02T16:59:39Z
canonical: "docs.mapp.com/request-parameters-data-object-php-library-s2s"
---

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

# Request Parameters

This page explains all query parameters used in Mapp Intelligence tracking requests. It provides a consolidated reference of parameter names, their meanings, data types, and required status.

Each parameter corresponds to a specific field in the Mapp Intelligence data model and can be transmitted directly, for example in **server-to-server** requests or when validating Smart Pixel implementations.

> [!NOTE]
> Note
> 
> The object-specific pages (e.g., Page, Order, Session, User) describe the concepts and configuration details.
> 
> This reference focuses on the exact parameter names (such as pn, ov, or uc700) that appear in tracking requests.

Typical use cases include:

- Validating and debugging tracking requests.
- Mapping SDK methods (e.g. setValue, setId) to corresponding query parameters.
- Comparing tracking payloads across implementation types.

---

## General

| **Parameter** | **Description** | **Type** | **Supported Request Type** | **Required** | **Example** |
| --- | --- | --- | --- | --- | --- |
| **EVER_ID (eid)** | Unique long-term visitor identifier automatically set by Mapp Intelligence. | String | page / event | ✓ | "1234567890123456789" |
| **CUSTOM_EVER_ID (ceid)** | Custom visitor identifier, if your own user ID is used instead of the system-generated eid. | String | page / event | – | "098f6bcd4621d373cade4e832627b4f6" |
| **ADVANCED_PERMISSION_CATEGORY (pec)** | Enable if you need to differentiate between additional usage options for the tracked data, e.g., only to your Intelligence instance or to both Intelligence and Engage. - 0 (default): only Intelligence - 3: Intelligence and Engage | Number | page / event | - | 0 |
| **USER_AGENT (X-WT-UA)** | Original client user agent string (optional, only relevant for server-side tracking). | String | page / event | – | "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:82.0) Gecko/20100101 Firefox/82.0" |
| **USER_IP (X-WT-IP)** | Original client IP address (optional, only relevant for server-side tracking). | String | page / event | – | "127.0.0.1" |

---

## Page

**Parameters**

| **Parameter** | **Description** | **Type** | **Supported Request Type** | **Required** | **Example** |
| --- | --- | --- | --- | --- | --- |
| **PAGE_NAME (pn)** | Technical name of the page (used for identification and grouping). | String | page | ✓ | "en.home" |
| **SEARCH (is)** | Search term used in the internal search function. | String | page | – | "running shoes" |
| **NUMBER_SEARCH_RESULTS (cp771)** | Number of search results returned for the entered term. | Number | page | – | 15 |
| **ERROR_MESSAGES (cp772)** | Error message displayed on the page. | String | page | – | "invalid password" |
| **PAYWALL (cp773)** | Indicates a paywall call. Use 1 for true. | Number | page | – | 1 |
| **ARTICLE_TITLE (cp774)** | Title of the displayed article or content item. | String | page | – | "Best Trail Running Shoes" |
| **CONTENT_TAGS (cp775)** | Tags or categories assigned to the content. | String | page | – | "sports, gear" |
| **PAGE_TITLE (cp776)** | Display title of the page (as shown in browser tab or CMS). | String | page | – | "Running Gear 2025" |
| **PAGE_TYPE (cp777)** | Type of the page, e.g. article, category, homepage. | String | page | – | "product page" |
| **PAGE_LENGTH (cp778)** | Indicates the amount of content or reading length category (e.g. short, medium, long). | String | page | – | "long" |
| **DAYS_SINCE_PUBLICATION (cp779)** | Number of days since the article was published. | Number | page | – | 8 |
| **TEST_VARIANT (cp781)** | Name of the A/B test variant shown to the visitor. | String | page | – | "variant B" |
| **TEST_EXPERIMENT (cp782)** | Name of the A/B test experiment. | String | page | – | "checkout-button-color" |
| **CUSTOM_PAGE_PARAMETER (cp<<1–499>>)** | Custom page parameters for additional information (e.g. category, language). | String / Number | page | – | "cp12 = 'EN'" |
| **CUSTOM_PAGE_CATEGORY (cg<<1–499>>)** | Page category or content group assigned to the page. | String / Number | page | – | "cg3 = 'Outdoor'" |

**Example**

```php
$mappIntelligence = MappIntelligence::getInstance();

$mappParameterMap = new MappIntelligenceParameterMap();
$mappParameterMap
	->add(MappIntelligenceParameter::$PAGE_NAME, "name of a page")
    ->add(MappIntelligenceParameter::$SEARCH, "search term")
    ->add(MappIntelligenceParameter::$NUMBER_SEARCH_RESULTS, "15")
    ->add(MappIntelligenceParameter::$ERROR_MESSAGES, "error message")
    ->add(MappIntelligenceParameter::$PAYWALL, "1")
    ->add(MappIntelligenceParameter::$ARTICLE_TITLE, "name of an article")
    ->add(MappIntelligenceParameter::$CONTENT_TAGS, "name of a content tag")
    ->add(MappIntelligenceParameter::$PAGE_TITLE, "title of a page")
    ->add(MappIntelligenceParameter::$PAGE_TYPE, "type of a page")
    ->add(MappIntelligenceParameter::$PAGE_LENGTH, "large")
    ->add(MappIntelligenceParameter::$DAYS_SINCE_PUBLICATION, "8")
    ->add(MappIntelligenceParameter::$TEST_VARIANT, "name of a variant")
    ->add(MappIntelligenceParameter::$TEST_EXPERIMENT, "name of an experiment")
    ->add(MappIntelligenceCustomParameter::$CUSTOM_PAGE_PARAMETER->with(1), "parameter 1")
    ->add(MappIntelligenceCustomParameter::$CUSTOM_PAGE_PARAMETER->with(2), "parameter 2")
    ->add(MappIntelligenceCustomParameter::$CUSTOM_PAGE_CATEGORY->with(1), "category 1")
    ->add(MappIntelligenceCustomParameter::$CUSTOM_PAGE_CATEGORY->with(2), "category 2");

$mappIntelligence->track($mappParameterMap);
```

---

## Event

**Parameters**

| **Parameter** | **Description** | **Type** | **Supported Request Type** | **Required** | **Example** |
| --- | --- | --- | --- | --- | --- |
| **ACTION_NAME (ct)** | Name of the tracked event, such as a click, video play, or form submission. | String | event | ✓ | "navigation.home" |
| **CUSTOM_ACTION_PARAMETER (ck<<1–499>>)** | Custom event parameters for additional event-specific information (e.g., link type, click area). | String / Number | event | – | "ck5 = 'CTA button'" |

**Example**

```php
$mappIntelligence = MappIntelligence::getInstance();

$mappParameterMap = new MappIntelligenceParameterMap();
$mappParameterMap
	->add(MappIntelligenceParameter::$PAGE_NAME, "name of a page")
	->add(MappIntelligenceParameter::$ACTION_NAME, "en.navigation.home")
    ->add(MappIntelligenceCustomParameter::$CUSTOM_ACTION_PARAMETER->with(1), "parameter 1")
    ->add(MappIntelligenceCustomParameter::$CUSTOM_ACTION_PARAMETER->with(2), "parameter 2");

$mappIntelligence->track($mappParameterMap);
```

---

## Campaign

**Parameters**

| **Parameter** | **Description** | **Type** | **Supported Request Type** | **Required** | **Example** |
| --- | --- | --- | --- | --- | --- |
| **CAMPAIGN_ID (mc)** | Unique identifier of a campaign. Consists of the media code name and its value, separated by “%3D”. | String | page / event | ✓ | "wt_mc=newsletter.summer.2025" |
| **CAMPAIGN_ACTION (mca)** | Campaign action - c (click) - v (view) | String | page / event | – | "c" |
| **CUSTOM_CAMPAIGN_PARAMETER (cc<<1–499>>)** | Campaign Parameters used to add contextual data to an Ad Media (e.g., link position in a newsletter, ad type, creative name). | String / Number | page / event | – | "cc1 = 'TopBanner'" |

**Example**

```php
$mappIntelligence = MappIntelligence::getInstance();

$mappParameterMap = new MappIntelligenceParameterMap();
$mappParameterMap
	->add(MappIntelligenceParameter::$PAGE_NAME, "name of a page")
	->add(MappIntelligenceParameter::$CAMPAIGN_ID, "wt_mc%3Dnewsletter")
	->add(MappIntelligenceParameter::$CAMPAIGN_ACTION, "c")
    ->add(MappIntelligenceCustomParameter::$CUSTOM_CAMPAIGN_PARAMETER->with(2), "parameter 2")
    ->add(MappIntelligenceCustomParameter::$CUSTOM_CAMPAIGN_PARAMETER->with(15), "parameter 15");

$mappIntelligence->track($mappParameterMap);
```

---

## User

**Parameters**

| **Parameter** | **Description** | **Type** | **Supported Request Type** | **Required** | **Example** |
| --- | --- | --- | --- | --- | --- |
| **CUSTOMER_ID (cd)** | Unique user identifier, e.g. customer number or hashed email address. | String | page / event | ✓ | "user12345" |
| **EMAIL (uc700)** | Hashed email address used to identify the user. | String | page / event | – | "~!5kWnPT+q95KgFwEE463v2ni5E/AxdAYV!~" |
| **EMAIL_RID (uc701)** | Email receiver ID assigned by Mapp Engage. | String | page / event | – | "abc123def456" |
| **EMAIL_OPTIN (uc702)** | Email opt-in status (1 = yes, 2 = no). | Number | page / event | – | 1 |
| **FIRST_NAME (uc703)** | First name of the user. | String | page / event | – | "John" |
| **LAST_NAME (uc704)** | Last name of the user. | String | page / event | – | "Doe" |
| **TELEPHONE (uc705)** | Telephone number of the user. | String | page / event | – | "+49 30 1234567" |
| **GENDER (uc706)** | Gender of the user (1 = male, 2 = female). | Number | page / event | – | 2 |
| **BIRTHDAY (uc707)** | Date of birth of the user (YYYYMMDD). | String | page / event | – | "19861231" |
| **COUNTRY (uc708)** | Country of the user. | String | page / event | – | "Germany" |
| **CITY (uc709)** | City of the user. | String | page / event | – | "Berlin" |
| **POSTAL_CODE (uc710)** | Postal code of the user. | String | page / event | – | "10115" |
| **STREET (uc711)** | Street of the user. | String | page / event | – | "Robert-Koch-Platz" |
| **STREET_NUMBER (uc712)** | Street number of the user. | String | page / event | – | "4" |
| **CUSTOMER_VALIDATION (uc713)** | Indicates if transmitted user data has been validated (1 = true). | Number | page / event | – | 1 |
| **CUSTOM_URM_CATEGORY (uc<<1–499>>)** | Custom user categories for segmentation (e.g., gender, loyalty tier). | String / Number | page / event | – | "uc2 = 'female'" |

**Example**

```php
$mappIntelligence = MappIntelligence::getInstance();

$mappParameterMap = new MappIntelligenceParameterMap();
$mappParameterMap
	->add(MappIntelligenceParameter::$PAGE_NAME, "name of a page")
	->add(MappIntelligenceParameter::$CUSTOMER_ID, "user5684798169")
    ->add(MappIntelligenceParameter::$EMAIL, "~!5kWnPT+q95KgFwEE463v2ni5E/AxdAYV!~") // info@webtrekk.com
    ->add(MappIntelligenceParameter::$EMAIL_RID, "abc123def456")
    ->add(MappIntelligenceParameter::$EMAIL_OPTIN, "1")
    ->add(MappIntelligenceParameter::$GENDER, "2")
    ->add(MappIntelligenceParameter::$CUSTOMER_VALIDATION, "1")
    ->add(MappIntelligenceCustomParameter::$CUSTOM_URM_CATEGORY->with(5), "login");

$mappIntelligence->track($mappParameterMap);
```

---

## Product

**Parameters**

| **Parameter** | **Description** | **Type** | **Supported Request Type** | **Required** | **Example** |
| --- | --- | --- | --- | --- | --- |
| **PRODUCT_ID (ba)** | Unique product identifier (e.g., SKU or article number). Must not exceed 110 characters. | String | page | ✓ | "product_1234" |
| **PRODUCT_COST (co)** | Product price. If multiple quantities are transmitted, use the total value (not unit price). | Number | page | – | 19.95 |
| **PRODUCT_QUANTITY (qn)** | Quantity of the product. | Number | page | – | 2 |
| **PRODUCT_STATUS (st)** | Current product status - VIEW - BASKET - ADD_TO_CART - DELETE_FROM_CART - CHECKOUT - CONFIRMATION - ADD_TO_WISHLIST - DELETE_FROM_WISHLIST | String | page | ✓ | ADD_TO_CART |
| **CURRENCY (cr)** | ISO currency code for the product price (e.g., EUR). | String | page | – | "EUR" |
| **PRODUCT_SOLD_OUT (cb760)** | Indicates product availability (1 = sold out, 0 = available). | Number | page | – | 0 |
| **PRODUCT_VARIANT (cb767)** | Variant of the product. | String | page | - | "red" |
| **CUSTOM_PRODUCT_CATEGORY (ca<<1–499>>)** | Product category or grouping (e.g., brand, type). | String / Number | page | – | "ca2 = 'Shoes'" |
| **CUSTOM_PRODUCT_PARAMETER (cb<<1–499>>)** | E-Commerce Parameters for additional product details (e.g., color, size, material). | String / Number | page | – | "cb3 = 'Blue'" |

**Example**

```php
$mappIntelligence = MappIntelligence::getInstance();

$mappParameterMap = new MappIntelligenceParameterMap();
$mappParameterMap
	->add(MappIntelligenceParameter::$PAGE_NAME, "name of a page")
	->add(MappIntelligenceParameter::$PRODUCT_ID, "product name")
    ->add(MappIntelligenceParameter::$PRODUCT_COST, "19.95")
    ->add(MappIntelligenceParameter::$PRODUCT_QUANTITY, "5")
    ->add(MappIntelligenceParameter::$PRODUCT_STATUS, MappIntelligenceProduct::VIEW)
    ->add(MappIntelligenceParameter::$CURRENCY, "EUR")
    ->add(MappIntelligenceParameter::$PRODUCT_SOLD_OUT, "1")
    ->add(MappIntelligenceCustomParameter::$CUSTOM_PRODUCT_PARAMETER->with(2), "parameter 2")
	->add(MappIntelligenceCustomParameter::$CUSTOM_PRODUCT_PARAMETER->with(15), "parameter 15")
	->add(MappIntelligenceCustomParameter::$CUSTOM_PRODUCT_CATEGORY->with(2), "category 2")
	->add(MappIntelligenceCustomParameter::$CUSTOM_PRODUCT_CATEGORY->with(15), "category 15");

$mappIntelligence->track($mappParameterMap);
```

---

## Order

**Parameters**

| **Parameter** | **Description** | **Type** | **Supported Request Type** | **Required** | **Example** |
| --- | --- | --- | --- | --- | --- |
| **ORDER_VALUE (ov)** | Total order value. Required for order tracking. Without this value, the order is not recorded. Use a dot or comma as decimal separator, without thousands separator. | Number | page | ✓ | 24.95 |
| **ORDER_ID (oi)** | Unique identifier for the order to prevent double counting. If not submitted, Mapp generates one automatically. | String | page | – | "ORD-A12345" |
| **CURRENCY (cr)** | ISO currency code for the order value. Used for currency conversion in Mapp Q3. | String | page | – | "EUR" |
| **COUPON_VALUE (cb563)** | Value of an applied coupon or discount. | Number | page | – | 10.00 |
| **PAYMENT_METHOD (cb761)** | Payment method used for the order (e.g., “PayPal”, “Credit Card”). | String | page | – | "PayPal" |
| **SHIPPING_SERVICE (cb762)** | Shipping provider used for the order. | String | page | – | "DHL" |
| **SHIPPING_SPEED (cb763)** | Selected shipping speed (e.g., “express”, “2d”). | String | page | – | "2d" |
| **SHIPPING_COSTS (cb764)** | Shipping costs associated with the order. | Number | page | – | 3.95 |
| **GROSS_MARGIN (cb765)** | Margin or mark-up of the order. | Number | page | – | 6.95 |
| **ORDER_STATUS (cb766)** | Current order status (e.g., “paid”, “cancelled”). | String | page | – | "paid" |
| **CUSTOM_PRODUCT_PARAMETER (cb<<1–499>>)** | Custom E-Commerce Parameters to enrich order data (e.g., delivery type, loyalty code, payment region). | String / Number | page | – | "cb45 = 'Express Delivery'" |

**Example**

```php
$mappIntelligence = MappIntelligence::getInstance();

$mappParameterMap = new MappIntelligenceParameterMap();
$mappParameterMap
	->add(MappIntelligenceParameter::$PAGE_NAME, "name of a page")
	->add(MappIntelligenceParameter::$ORDER_VALUE, "24.95")
    ->add(MappIntelligenceParameter::$COUPON_VALUE, "10.99")
    ->add(MappIntelligenceParameter::$PAYMENT_METHOD, "paypal")
    ->add(MappIntelligenceParameter::$ORDER_STATUS, "payed")
    ->add(MappIntelligenceParameter::$ORDER_ID, "ABC123")
    ->add(MappIntelligenceParameter::$GROSS_MARGIN, "6.95")
    ->add(MappIntelligenceParameter::$SHIPPING_SERVICE, "dhl")
    ->add(MappIntelligenceParameter::$SHIPPING_SPEED, "2d")
    ->add(MappIntelligenceParameter::$SHIPPING_COSTS, "3.95")
    ->add(MappIntelligenceParameter::$CURRENCY, "EUR")
    ->add(MappIntelligenceCustomParameter::$CUSTOM_PRODUCT_PARAMETER->with(2), "parameter 2")
    ->add(MappIntelligenceCustomParameter::$CUSTOM_PRODUCT_PARAMETER->with(15), "parameter 15");

$mappIntelligence->track($mappParameterMap);
```

---

## Session

**Parameters**

| **Parameter** | **Description** | **Type** | **Supported Request Type** | **Required** | **Example** |
| --- | --- | --- | --- | --- | --- |
| **LOGIN_STATUS (cs800)** | Tracks the user’s login state during a session (e.g., “logged in”, “guest”). | String | page / event | – | "logged in" |
| **TEMPORARY_SESSION_ID (fpv)** | Temporary ID that keeps a session consistent without storing data permanently on the user’s device. | String | page / event | – | "abc123" |
| **CUSTOM_SESSION_PARAMETER (cs<<1–499>>)** | Custom Session Parameters used to enrich session-level data (e.g., A/B test variant, NPS feedback, test group). Only one value per session is stored (first or last, based on account settings). | String / Number | page / event | – | "cs12 = 'A/B Test Group B'" |

**Example**

```php
$mappIntelligence = MappIntelligence::getInstance();

$mappParameterMap = new MappIntelligenceParameterMap();
$mappParameterMap
	->add(MappIntelligenceParameter::$PAGE_NAME, "name of a page")
	->add(MappIntelligenceParameter::$LOGIN_STATUS, "logged in")
	->add(MappIntelligenceParameter::$TEMPORARY_SESSION_ID, "abc123")
	->add(MappIntelligenceParameter::$TEMPORARY_SESSION_ID_TYPE, "2.0.0")
    ->add(MappIntelligenceCustomParameter::$CUSTOM_SESSION_PARAMETER->with(2), "parameter 2")
    ->add(MappIntelligenceCustomParameter::$CUSTOM_SESSION_PARAMETER->with(15), "parameter 15");

$mappIntelligence->track($mappParameterMap);
```

---

## Mapp Engage

**Parameters**

| **Parameter** | **Description** | **Type** | **Supported Request Type** | **Required** | **Example** |
| --- | --- | --- | --- | --- | --- |
| **ENGAGE_ATTRIBUTES (eaj)** | Sends user-specific attributes to Mapp Engage. These can be stored as *Custom Profile Attributes* for segmentation and targeting. | Object | page / event | – | { "sizeFinderUsed": true, "favBrand": "Acme" } |
| **ENGAGE_EVENT_NAME (ecwen)** | Defines the name of the Engage *Custom Web Event* (e.g., “Size Finder Used”). This can trigger automations in the Whiteboard. | String | page / event | – | "Size Finder Used" |
| **ENGAGE_EVENT_ID (ecwei)** | Alternative to event_name. Refers to the numeric *Custom Web Event ID* defined in Engage. Mainly used for advanced setups. | Number | page / event | – | 101 |

**Example**

```php
$mappIntelligence = MappIntelligence::getInstance();

$mappParameterMap = new MappIntelligenceParameterMap();
$mappParameterMap
	->add(MappIntelligenceParameter::$PAGE_NAME, "name of a page")
	->add(MappIntelligenceParameter::$ENGAGE_ATTRIBUTES, json_encode(array("engage.attribute.fittingToolUsed" => "true")))
	->add(MappIntelligenceParameter::$ENGAGE_EVENT_NAME, "Virtual Fitting Room Used")
    ->add(MappIntelligenceParameter::$ENGAGE_EVENT_ID, "12345");

$mappIntelligence->track($mappParameterMap);
```

---

## Mapp Engage User Matching

**Parameters**

> [!NOTE]
> Note
> 
> To enable data exchange between Mapp Intelligence and Engage, User Matching must be active.
> 
> The minimum requirement for Web Matching is a valid email address (er1).
> 
> The Engage Contact ID (uc701) is exchanged automatically between systems and normally does not appear in web tracking requests.

| **Parameter** | **Description** | **Type** | **Supported Request Type** | **Required** | **Example** |
| --- | --- | --- | --- | --- | --- |
| **REGISTRATION_EMAIL (er1)** | Email address used to identify or create a contact in Engage. Usually transmitted in hashed form. | String | page / event | ✅ | "hash@example.com" |
| **REGISTRATION_FIELDS (er2 – er10)** | Optional registration-related fields such as - REGISTRATION_GROUP_ID - REGISTRATION_MODE - REGISTRATION_FIRST_NAME - REGISTRATION_LAST_NAME - REGISTRATION_GENDER - REGISTRATION_TITLE - REGISTRATION_ISO_CODE - REGISTRATION_ISO_LANGUAGE - REGISTRATION_TIMEZONE The exact mapping of these fields depends on your Engage setup. | String / Number | page / event | – | "er2=123", "er3=d", "er4=Anna", "er8=DE", "er9=de", "er10=Europe/Berlin" |
| **EMAIL_RID (uc701)** | Engage Contact ID used for campaign- or app-based user matching. Usually only visible in requests from campaigns or mobile SDKs. | String | page / event | – | "abc123def456" |

**Notes:**

- **MODE values:** c = *Confirmed Opt-in*, d = *Double Opt-in*, o = *Opt-in (default)*
- **GENDER values:** u = *undisclosed*, f = *female*, m = *male*
- **ISO_CODE values (er8):** two-letter ISO 3166-1 country code, e.g. *DE*
- **ISO_LANGUAGE values (er9):** two-letter ISO 639-1 language code, e.g. *de*
- **TIMEZONE values (er10):** IANA time zone name, e.g. *Europe/Berlin*
- Campaign Matching automatically appends uc701 to Engage campaign URLs.
- For Web Matching, tracking the **email (er1)** is sufficient for identification and linking.

**Example**

```php
$mappIntelligence = MappIntelligence::getInstance();

$mappParameterMap = new MappIntelligenceParameterMap();
$mappParameterMap
	->add(MappIntelligenceParameter::$PAGE_NAME, "registration.page")
    ->add(MappIntelligenceParameter::$REGISTRATION_EMAIL, "john.doe@example.com")
    ->add(MappIntelligenceParameter::$REGISTRATION_GROUP_ID, "123")
    ->add(MappIntelligenceParameter::$REGISTRATION_MODE, "d")
    ->add(MappIntelligenceParameter::$REGISTRATION_FIRST_NAME, "John")
    ->add(MappIntelligenceParameter::$REGISTRATION_LAST_NAME, "Doe")
    ->add(MappIntelligenceParameter::$REGISTRATION_GENDER, "m")
    ->add(MappIntelligenceParameter::$REGISTRATION_ISO_CODE, "DE")
    ->add(MappIntelligenceParameter::$REGISTRATION_ISO_LANGUAGE, "de")
    ->add(MappIntelligenceParameter::$REGISTRATION_TIMEZONE, "Europe/Berlin");

$mappIntelligence->track($mappParameterMap);
```