Documentation

Developers

API References
Data Subject Request API

Data Subject Request API Version 1 and 2

Data Subject Request API Version 3

Platform API

Platform API Overview

Accounts

Apps

Audiences

Calculated Attributes

Data Points

Feeds

Field Transformations

Services

Users

Workspaces

Warehouse Sync API

Warehouse Sync API Overview

Warehouse Sync API Tutorial

Warehouse Sync API Reference

Data Mapping

Warehouse Sync SQL Reference

Warehouse Sync Troubleshooting Guide

ComposeID

Warehouse Sync API v2 Migration

Bulk Profile Deletion API Reference

Calculated Attributes Seeding API

Custom Access Roles API

Data Planning API

Group Identity API Reference

Pixel Service

Profile API

Events API

mParticle JSON Schema Reference

IDSync

Client SDKs
AMP

AMP SDK

Android

Initialization

Configuration

Network Security Configuration

Event Tracking

User Attributes

IDSync

Screen Events

Commerce Events

Location Tracking

Media

Kits

Application State and Session Management

Data Privacy Controls

Error Tracking

Opt Out

Push Notifications

WebView Integration

Logger

Preventing Blocked HTTP Traffic with CNAME

Linting Data Plans

Troubleshooting the Android SDK

API Reference

Upgrade to Version 5

Cordova

Cordova Plugin

Identity

Direct Url Routing

Direct URL Routing FAQ

Web

Android

iOS

Flutter

Getting Started

Usage

API Reference

React Native

Getting Started

Identity

Roku

Getting Started

Identity

Media

iOS

Initialization

Configuration

Event Tracking

User Attributes

IDSync

Screen Tracking

Commerce Events

Location Tracking

Media

Kits

Application State and Session Management

Data Privacy Controls

Error Tracking

Opt Out

Push Notifications

Webview Integration

Upload Frequency

App Extensions

Preventing Blocked HTTP Traffic with CNAME

Linting Data Plans

Troubleshooting iOS SDK

Social Networks

iOS 14 Guide

iOS 15 FAQ

iOS 16 FAQ

iOS 17 FAQ

iOS 18 FAQ

API Reference

Upgrade to Version 7

Xbox

Getting Started

Identity

Unity

Upload Frequency

Getting Started

Opt Out

Initialize the SDK

Event Tracking

Commerce Tracking

Error Tracking

Screen Tracking

Identity

Location Tracking

Session Management

Web

Initialization

Content Security Policy

Configuration

Event Tracking

User Attributes

IDSync

Page View Tracking

Commerce Events

Location Tracking

Media

Kits

Application State and Session Management

Data Privacy Controls

Error Tracking

Opt Out

Custom Logger

Persistence

Native Web Views

Self-Hosting

Multiple Instances

Web SDK via Google Tag Manager

Preventing Blocked HTTP Traffic with CNAME

Facebook Instant Articles

Troubleshooting the Web SDK

Browser Compatibility

Linting Data Plans

API Reference

Upgrade to Version 2 of the SDK

Xamarin

Getting Started

Identity

Web

Alexa

Server SDKs

Node SDK

Go SDK

Python SDK

Ruby SDK

Java SDK

Tools

mParticle Command Line Interface

Linting Tools

Smartype

Media SDKs

Android

Web

iOS

Quickstart
Android

Overview

Step 1. Create an input

Step 2. Verify your input

Step 3. Set up your output

Step 4. Create a connection

Step 5. Verify your connection

Step 6. Track events

Step 7. Track user data

Step 8. Create a data plan

Step 9. Test your local app

HTTP Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

iOS Quick Start

Overview

Step 1. Create an input

Step 2. Verify your input

Step 3. Set up your output

Step 4. Create a connection

Step 5. Verify your connection

Step 6. Track events

Step 7. Track user data

Step 8. Create a data plan

Java Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Node Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Python Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Web

Overview

Step 1. Create an input

Step 2. Verify your input

Step 3. Set up your output

Step 4. Create a connection

Step 5. Verify your connection

Step 6. Track events

Step 7. Track user data

Step 8. Create a data plan

Guides
Partners

Introduction

Outbound Integrations

Outbound Integrations

Firehose Java SDK

Inbound Integrations

Kit Integrations

Overview

Android Kit Integration

JavaScript Kit Integration

iOS Kit Integration

Data Hosting Locations

Compose ID

Glossary

Migrate from Segment to mParticle

Migrate from Segment to mParticle

Migrate from Segment to Client-side mParticle

Migrate from Segment to Server-side mParticle

Segment-to-mParticle Migration Reference

Rules Developer Guide

API Credential Management

The Developer's Guided Journey to mParticle

Guides

Getting Started

Create an Input

Start capturing data

Connect an Event Output

Create an Audience

Connect an Audience Output

Transform and Enhance Your Data

Platform Guide
The New mParticle Experience

The new mParticle Experience

The Overview Map

Observability

Observability Overview

Observability User Guide

Observability Span Glossary

Introduction

Data Retention

Connections

Activity

Live Stream

Data Filter

Rules

Tiered Events

mParticle Users and Roles

Analytics Free Trial

Troubleshooting mParticle

Usage metering for value-based pricing (VBP)

Analytics

Introduction

Setup

Sync and Activate Analytics User Segments in mParticle

User Segment Activation

Welcome Page Announcements

Settings

Project Settings

Roles and Teammates

Organization Settings

Global Project Filters

Portfolio Analytics

Analytics Data Manager

Analytics Data Manager Overview

Events

Event Properties

User Properties

Revenue Mapping

Export Data

UTM Guide

Query Builder

Data Dictionary

Query Builder Overview

Modify Filters With And/Or Clauses

Query-time Sampling

Query Notes

Filter Where Clauses

Event vs. User Properties

Group By Clauses

Annotations

Cross-tool Compatibility

Apply All for Filter Where Clauses

Date Range and Time Settings Overview

Understanding the Screen View Event

Analyses

Analyses Introduction

Segmentation: Basics

Getting Started

Visualization Options

For Clauses

Date Range and Time Settings

Calculator

Numerical Settings

Segmentation: Advanced

Assisted Analysis

Properties Explorer

Frequency in Segmentation

Trends in Segmentation

Did [not] Perform Clauses

Cumulative vs. Non-Cumulative Analysis in Segmentation

Total Count of vs. Users Who Performed

Save Your Segmentation Analysis

Export Results in Segmentation

Explore Users from Segmentation

Funnels: Basics

Getting Started with Funnels

Group By Settings

Conversion Window

Tracking Properties

Date Range and Time Settings

Visualization Options

Interpreting a Funnel Analysis

Funnels: Advanced

Group By

Filters

Conversion over Time

Conversion Order

Trends

Funnel Direction

Multi-path Funnels

Analyze as Cohort from Funnel

Save a Funnel Analysis

Explore Users from a Funnel

Export Results from a Funnel

Cohorts

Getting Started with Cohorts

Analysis Modes

Save a Cohort Analysis

Export Results

Explore Users

Saved Analyses

Manage Analyses in Dashboards

Journeys

Getting Started

Event Menu

Visualization

Ending Event

Save a Journey Analysis

Users

Getting Started

User Activity Timelines

Time Settings

Export Results

Save A User Analysis

Dashboards

Dashboards––Getting Started

Manage Dashboards

Organize Dashboards

Dashboard Filters

Scheduled Reports

Favorites

Time and Interval Settings in Dashboards

Query Notes in Dashboards

User Aliasing

Analytics Resources

The Demo Environment

Keyboard Shortcuts

Tutorials

Analytics for Marketers

Analytics for Product Managers

Compare Conversion Across Acquisition Sources

Analyze Product Feature Usage

Identify Points of User Friction

Time-based Subscription Analysis

Dashboard Tips and Tricks

Understand Product Stickiness

Optimize User Flow with A/B Testing

User Segments

APIs

User Segments Export API

Dashboard Filter API

IDSync

IDSync Overview

Use Cases for IDSync

Components of IDSync

Store and Organize User Data

Identify Users

Default IDSync Configuration

Profile Conversion Strategy

Profile Link Strategy

Profile Isolation Strategy

Best Match Strategy

Aliasing

Data Master
Group Identity

Overview

Create and Manage Group Definitions

Introduction

Catalog

Live Stream

Data Plans

Data Plans

Blocked Data Backfill Guide

Personalization
Predictive Attributes

Predictive Attributes Overview

Create Predictive Attributes

Assess and Troubleshoot Predictions

Use Predictive Attributes in Campaigns

Predictive Audiences

Predictive Audiences Overview

Using Predictive Audiences

Introduction

Profiles

Calculated Attributes

Calculated Attributes Overview

Using Calculated Attributes

Create with AI Assistance

Calculated Attributes Reference

Audiences

Audiences Overview

Real-time Audiences

Standard Audiences

Journeys

Journeys Overview

Manage Journeys

Download an audience from a journey

Audience A/B testing from a journey

Journeys 2.0

Warehouse Sync

Data Privacy Controls

Data Subject Requests

Default Service Limits

Feeds

Cross-Account Audience Sharing

Approved Sub-Processors

Import Data with CSV Files

Import Data with CSV Files

CSV File Reference

Glossary

Video Index

Analytics (Deprecated)
Identity Providers

Single Sign-On (SSO)

Setup Examples

Settings

Debug Console

Data Warehouse Delay Alerting

Introduction

Developer Docs

Introduction

Integrations

Introduction

Rudderstack

Google Tag Manager

Segment

Data Warehouses and Data Lakes

Advanced Data Warehouse Settings

AWS Kinesis (Snowplow)

AWS Redshift (Define Your Own Schema)

AWS S3 Integration (Define Your Own Schema)

AWS S3 (Snowplow Schema)

BigQuery (Snowplow Schema)

BigQuery Firebase Schema

BigQuery (Define Your Own Schema)

GCP BigQuery Export

Snowflake (Snowplow Schema)

Snowplow Schema Overview

Snowflake (Define Your Own Schema)

APIs

Dashboard Filter API (Deprecated)

REST API

User Segments Export API (Deprecated)

SDKs

SDKs Introduction

React Native

iOS

Android

Java

JavaScript

Python

Object API

Developer Basics

Aliasing

Integrations

24i

Event

Aarki

Audience

Abakus

Event

ABTasty

Audience

Actable

Feed

AdChemix

Event

Adikteev

Audience

Event

Adjust

Event

Feed

AdMedia

Audience

Adobe Marketing Cloud

Cookie Sync

Event

Adobe Audience Manager

Audience

Adobe Target

Audience

AdPredictive

Feed

Adobe Campaign Manager

Audience

Airship

Audience

Event

Feed

Algolia

Event

AgilOne

Event

AlgoLift

Event

Feed

Alooma

Event

Amazon Advertising

Audience

Amazon Kinesis

Event

Amazon Kinesis Firehose

Audience

Event

Amazon S3

Event

Amazon Redshift

Data Warehouse

Adobe Marketing Cloud

Event

Amazon SNS

Event

Amazon SQS

Event

Amobee

Audience

Amplitude

Event

Forwarding Data Subject Requests

Analytics

Audience

Event

Forwarding Data Subject Requests

Ampush

Audience

Event

AppsFlyer

Event

Feed

Forwarding Data Subject Requests

AppLovin

Audience

Event

Apptentive

Event

Anodot

Event

Apptimize

Event

Apteligent

Event

Attentive

Event

Feed

Attractor

Event

Batch

Event

Audience

Bidease

Audience

Bing Ads

Event

Bluecore

Event

Microsoft Azure Blob Storage

Event

Bluedot

Feed

Blueshift

Event

Feed

Forwarding Data Subject Requests

Branch

Event

Feed

Forwarding Data Subject Requests

Branch S2S Event

Event

Braze

Audience

Forwarding Data Subject Requests

Feed

Event

Button

Audience

Event

Cadent

Audience

Bugsnag

Event

Census

Feed

ciValue

Event

Feed

CleverTap

Event

Audience

Feed

comScore

Event

Conversant

Event

Cordial

Audience

Feed

Criteo

Audience

Event

Crossing Minds

Event

Cortex

Event

Feed

Forwarding Data Subject Requests

CustomerGlu

Event

Feed

Customer.io

Audience

Feed

Event

Databricks

Data Warehouse

Custom Feed

Custom Feed

Antavo

Feed

Datadog

Event

Dynalyst

Audience

Didomi

Event

Dynamic Yield

Audience

Event

Emarsys

Audience

Edge226

Audience

Epsilon

Event

Everflow

Audience

Facebook Offline Conversions

Event

Facebook

Event

Audience

Google Analytics for Firebase

Event

Flurry

Event

Fiksu

Audience

Event

Flybits

Event

ForeSee

Event

Formation

Event

Feed

Foursquare

Feed

Audience

FreeWheel Data Suite

Audience

Google Ads

Audience

Event

Google Analytics

Event

Google Ad Manager

Audience

Google Analytics 4

Event

Google BigQuery

Audience

Data Warehouse

Google Cloud Storage

Audience

Event

Google Enhanced Conversions

Event

Google Marketing Platform

Audience

Cookie Sync

Event

Google Pub/Sub

Event

Google Marketing Platform Offline Conversions

Event

Heap

Event

Herow

Feed

Google Tag Manager

Event

Hightouch

Feed

Hyperlocology

Event

Indicative

Event

Audience

Ibotta

Event

Impact

Event

InMarket

Audience

InMobi

Audience

Event

Insider

Audience

Event

Feed

Intercom

Event

Inspectlet

Event

iPost

Audience

Feed

ironSource

Audience

Jampp

Audience

Event

Iterable

Audience

Feed

Event

Kafka

Event

Kayzen

Audience

Event

Kissmetrics

Event

Kochava

Feed

Event

Forwarding Data Subject Requests

Klaviyo

Audience

Event

Kubit

Event

LaunchDarkly

Feed

Leanplum

Feed

Event

Audience

LifeStreet

Audience

Liftoff

Audience

Event

LiveLike

Event

Liveramp

Audience

MadHive

Audience

mAdme Technologies

Event

Mailchimp

Audience

Event

Feed

Localytics

Event

Marigold

Audience

Mautic

Audience

Event

MediaMath

Audience

Mediasmart

Audience

Microsoft Azure Event Hubs

Event

Mixpanel

Audience

Forwarding Data Subject Requests

Event

MoEngage

Audience

Feed

Event

Mintegral

Audience

Moloco

Event

Audience

Monetate

Event

Movable Ink

Event

Movable Ink - V2

Event

Multiplied

Event

Nanigans

Event

myTarget

Audience

Event

Nami ML

Feed

Narrative

Audience

Event

Feed

NCR Aloha

Event

Optimizely

Audience

Event

Neura

Event

OneTrust

Event

Oracle BlueKai

Event

Paytronix

Feed

Oracle Responsys

Event

Audience

Persona.ly

Audience

PieEye

Inbound Data Subject Requests

Personify XP

Event

Plarin

Event

Pilgrim

Feed

Event

Pinterest

Event

Audience

Postie

Event

Audience

Punchh

Audience

Event

Feed

Primer

Event

Qualtrics

Event

Pushwoosh

Event

Audience

Quantcast

Event

Radar

Event

Feed

Remerge

Event

Audience

Reddit

Audience

Event

Regal

Event

Retina AI

Event

Feed

Reveal Mobile

Event

Rokt

Audience

RTB House

Audience

Event

Sailthru

Audience

Event

RevenueCat

Feed

Salesforce Email

Audience

Feed

Event

Salesforce Mobile Push

Event

Samba TV

Audience

Event

Scalarr

Event

SendGrid

Audience

Feed

SessionM

Event

Feed

ShareThis

Audience

Feed

Shopify

Custom Pixel

Feed

Signal

Event

SimpleReach

Event

Singular

Event

Feed

Singular-DEPRECATED

Event

Skyhook

Event

Slack

Event

SmarterHQ

Event

Snapchat

Event

Audience

Snapchat Conversions

Event

Smadex

Audience

Snowplow

Event

Snowflake

Data Warehouse

Split

Event

Feed

Sprig

Audience

Event

Splunk MINT

Event

StartApp

Audience

Statsig

Event

Feed

Stormly

Audience

Event

Swrve

Feed

Event

Talon.One

Audience

Event

Feed

Tapad

Audience

Tapjoy

Audience

Taptica

Audience

Taplytics

Event

Teak

Audience

The Trade Desk

Audience

Cookie Sync

Event

Ticketure

Feed

TikTok Event

Audience

Audience (Deprecated)

Event

Audience Migration

Triton Digital

Audience

Quadratic Labs

Event

Treasure Data

Audience

Event

Valid

Event

Twitter

Audience

Event

TUNE

Event

Vkontakte

Audience

Vungle

Audience

Voucherify

Audience

Event

Webhook

Event

Webtrends

Event

White Label Loyalty

Event

Xandr

Audience

Cookie Sync

Wootric

Event

YouAppi

Audience

Yahoo (formerly Verizon Media)

Audience

Cookie Sync

Z2A Digital

Audience

Event

Yotpo

Feed

Zendesk

Event

Feed

Event

Zendesk is a customer service platform. It’s designed for companies that want to create customer relationships that are more meaningful, personal, and productive. The Zendesk event integration supplements customer support by providing them additional context about their users; allowing them to provide a more personalized experience.

Prerequisites

The Zendesk integration uses the Sunshine Events API which is currently part of an Early Access Program to track events against a Sunshine profile. You need to ensure your Sunshine plan is properly configured to use the integration by selecting Admin > Settings > Subscription at https://your-zendesk-subdomain.zendesk.com/admin/billing/subscription.

The following items are required:

  1. A Zendesk Account.
  2. A Zendesk Sunshine Professional Plan or higher.

    • Zendesk Sunshine Professional is the minimum required, but we recommend Enterprise or higher to avoid hitting Sunshine API limits.
    • For more information check Plan Availability.
  3. Account Verification.

  4. A Zendesk Sunshine API token.

Data Processing Notes

When you create a connection to Zendesk, forwarding for all existing data points will initially be set to off, and send new data points by default will be disabled. You must enable the specific data points that you wish to forward to Zendesk.

mParticle recommends working with your Zendesk account manager before forwarding all events to your Zendesk account in the event Filter. This will ensure that you have a sufficient plan to handle the additional events - check Zendesk rate limits.

mParticle will only forward events to Zendesk if:

  1. An email address has been provided as identity in the event
  2. The payload is less than ~2 Kilobytes - Event maximum payload
  3. If a commerce payload is greater than ~2 Kilobytes, it will be split into separate requests for each product. The description property will contain information on the set it belongs to; e.g., 1 of N. Please see specific commerce event types to learn more.

Enabling User Profiles And Events In Zendesk

After you have finished configuring the integration in mParticle, and began forwarding events to Zendesk, you have to enable which of these user profiles and events that have already been forwarded will be visible in the customer context. To do this please follow the instructions on how to Add Sunshine user profiles and events to customer context in a ticket

Forwarded JSON Payload Example

This is an example of a JSON payload send to the Zendesk API with Event Source set to mParticle and Profile Type set to customer.

{
    "profile": {
        "source": "mParticle",
        "type": "customer",
        "identifiers": [{
                "type": "email",
                "value": "some@email.com"
            }
        ],
        "attributes": {
            "some_attribute_1": "some-attribute-value-1",
            "some_attribute_2": "some-attribute-value-2"
        }
    },
    "event": {
        "type": "some-app-event-name",
        "source": "mParticle",
        "properties": {
            "custom_attributes": {
                "some_attribute_name": "some-attribute-value"
            }
        }
    }
  }
}

Event Data Mapping

The following field mappings apply for all supported events.

Profile mappings

Parameter Zendesk Field mParticle Details
Event Source profile.source Taken from Configuration Settings, default is mParticle
Profile Type profile.type Taken from Configuration Settings, default is customer
user_attributes profile.name If $FirstName and $LastName attributes are defined, name attribute will be included
user_attributes profile.attributes Will include all defined attributes except $FirstName and $LastName
user_identities profile.identifiers Must include an email identity type

Event mappings

Parameter Zendesk Field mParticle Details
Event Source event.source Specified in Connection Settings
- event.type Check specific type of event for respective mapping of this field
custom_attributes event.properties.custom_attributes All attribute items will be added to custom_attributes property
- event.description Only set on commerce events that have been split into a set of events, it will contain a text describing the part of the set it belongs to; e.g., 1 of N.

The event.type is set based on the type of event:

mParticle Event Type event.type
screen_view Screen View
custom_event The event_name specified in the custom event
commerce_event (Product Action) eCommerce - product_action
commerce_event (Promotion Action) eCommerce - Promotion promotion_action
commerce_event (Impression) eCommerce - Impression

Screen View Events

The following field mappings apply for Screen View events.

Parameter Zendesk Field mParticle Details
- event.type Screen View string will be sent as value for this field
screen_name event.properties.screen_name The value sent in screen_name property in the event

Screen View (event) JSON Sample

{
    "type": "Screen View",
    "source": "mParticle",
    "properties": {
        "screen_name": "About",
        "custom_attributes": {
            "some_attribute_name": "some-attribute-value"
        }
    }
}

Custom Events

The following field mappings apply for Custom Events.

Parameter Zendesk Field mParticle Details
event_name event.type The event_name specified in the custom event
custom_event_type event.properties.custom_event_type The value sent in custom_event_type property in the event. e.g.: UserPreference, Navigation, ProductCheckout

Custom Event (event) JSON Sample

{
    "type": "custom event name",
    "source": "mParticle",
    "properties": {
        "custom_event_type": "Other",
        "custom_attributes": {
            "some_attribute_name": "some-attribute-value"
        }
    }
}

Commerce Events

The following field mappings apply for Product Commerce Events.

Product-based

Parameter Zendesk Field mParticle Details
event_name event.type The value sent in event_name property in the event
action event.properties.action The value sent in action property of the product_action property in the event, e.g.: AddToCart, Checkout, RemoveFromWishlist
transaction_id event.properties.transaction_id The value sent in transaction_id property of the product_action property in the event
currency_code event.properties.currency_code The value sent in currency_code property in the event
total_amount event.properties.total_amount The value sent in total_amount property of the product_action property in the event
tax_amount event.properties.tax_amount The value sent in tax_amount property of the product_action property in the event
shipping_amount event.properties.shipping_amount The value sent in shipping_amount property of the product_action property in the event
coupon_code event.properties.coupon_code The value sent in coupon_code property of the product_action property in the event
timestamp_unixtime_ms event.properties.timestamp_unixtime_ms The value sent in timestamp_unixtime_ms property in the event
products event.properties.products The array of products sent in products property of the product_action property in the event

Product-Based JSON Sample

{
    "type": "eCommerce - AddToCart",
    "source": "mParticle",
    "properties": {
        "action": "AddToCart",
        "transaction_id": "some-transaction-id",
        "currency_code": "USD",
        "total_amount": "1.99",
        "tax_amount": "0.50",
        "shipping_amount": "1.00",
        "coupon_code": "some-coupon-code",
        "timestamp_unixtime_ms": "1605805232479",
        "products": [{
                "id": "some-product-id",
                "name": "some-product-name",
                "brand": "some-product-brand",
                "category": "some-product-category",
                "position": "1",
                "price": "1.99",
                "quantity": "1",
                "coupon_code": "some-product-coupon-code",
                "total_product_amount": "1.99",
                "product_attributes": {
                    "some_product_attribute_name": "some-product-attribute-value"
                }
            }
        ],
        "custom_attributes": {
            "some_attribute_name": "some-attribute-value"
        }
    }
}

Promotion-based

The following field mappings apply for Promotion Commerce Events.

Parameter Zendesk Field mParticle Details
event_name event.type The value sent in event_name property in the event
action event.properties.action The value sent in action property of the promotion_action property in the event, e.g.: PromotionView, PromotionClick
timestamp_unixtime_ms event.properties.timestamp_unixtime_ms The value sent in timestamp_unixtime_ms property in the event
promotions event.properties.promotions The array of promotions sent in promotions property of the promotion_action property in the event

Promotion-Based JSON Sample

{
    "type": "eCommerce - PromotionView",
    "source": "mParticle",
    "properties": {
        "action": "PromotionView",
        "promotions": [{
                "id": "some-promotion-id",
                "name": "some-promotion-name",
                "creative": "some-creative-name",
                "position": "some-position-value"
            }
        ],
        "custom_attributes": {
            "some_attribute_name": "some-attribute-value"
        }
    }
}

Impression-based

The following field mappings apply for Impression Commerce Events.

Parameter Zendesk Field mParticle Details
event_name event.type The value sent in event_name property in the event
product_impressions event.properties.product_impressions The array of product impressions sent in product_impressions property in the event

Impression-Based JSON Sample

{
    "type": "eCommerce - Impression",
    "source": "mParticle",
    "properties": {
        "product_impressions": [{
                "product_impression_list": "some-product-impresion-list-name",
                "products": [{
                        "id": "some-product-id",
                        "name": "some-product-name",
                        "brand": "some-product-brand",
                        "category": "some-product-category",
                        "position": "1",
                        "price": "1.99",
                        "quantity": "1",
                        "coupon_code": "some-product-coupon-code",
                        "total_product_amount": "1.99",
                        "product_attributes": {
                            "some_product_attribute_name": "some-product-attribute-value"
                        }
                    }
                ]
            }
        ],
        "custom_attributes": {
            "some_attribute_name": "some-attribute-value"
        }
    }
}

Configuration Settings

Setting Name Data Type Default Value Description
Authentication Email Address string Email address for API authentication
API Token string API tokens are auto-generated passwords in the Support admin interface on Zendesk platform
Subdomain string The subdomain can be identified from the Zendesk account’s URL. For example: if your URL is https://your-zendesk-subdomain.zendesk.com, then the subdomain value is your-zendesk-subdomain

Connection Settings

Setting Name Data Type Default Value Platform Description
Event Source string mParticle All Application which sent the event
Profile Type string customer All Is a user-defined name that lets you create different kinds of profiles for a given source. Example: “customer” for the customer profiles
    Last Updated: December 5, 2024