Campaign

Learn about the type that represents a marketing campaign.

A campaign identifies the marketing effort that drove the user to the application, based on UTM parameters widely used in digital marketing for tracking and analytics purposes.

Properties

These are the available properties:

name(optional)
string

A unique identifier for the campaign. It is usually a short string, such as “summer-sale” or “new-product-launch”.

source(optional)
string

The advertiser, site, or publication generating the traffic. For example, “google”, “facebook”, or “newsletter”.

medium(optional)
string

The advertising or marketing channel used to reach the user. For example, “email”, “video”, or “social”.

content(optional)
string

An identification of the specific ad or content the user interacted with. For example, “main-banner” or “newsletter-cta”.

term(optional)
string

The keyword or term that triggered the ad. For example, “running shoes” or “tennis racket”.

Payload examples

Below is a payload example for this type:

1234567
{  "name": "winter-sale",  "source": "google",  "medium": "search",  "content": "shoes",  "term": "black shoes"}