MarketingEvents

Columns

Name

Type

ReadOnly

Description

Id [KEY]

Long

True

A unique numeric identifier for the marketing event.

RemoteId

String

False

An optional remote identifier for a marketing event.

BreadcrumbId

String

True

An optional identifier for the breadcrumb of a marketing event.

UTMCampaign

String

True

A unique name for the UTM campaign.

UTMSource

String

True

The source of the UTM campaign.

UTMMedium

String

True

The medium of the UTM campaign.

UTMContent

String

True

The content of the UTM campaign.

UTMTerm

String

True

The term of the UTM campaign.

EventTarget

String

True

The target of the event.

Description

String

True

A description for the marketing event.

MarketingChannel

String

False

A broader marketing event type that is focused only on the channel. Must be one of the allowed values (`search`, `display`, `social`, `email`, `referral`).

EventType

String

False

The specific type of marketing event. Must be one of the allowed values (`ad`, `post`, `message`, `retargeting`, `transactional`, `affiliate`, `loyalty`, `newsletter`, `abandoned_cart`, `receipt`).

Budget

Decimal

False

The budget of the ad campaign.

Paid

Boolean

False

A boolean field to specify whether this event is paid or organic.

BudgetType

String

False

The type of the budget; must be either `daily` or `lifetime`.

Currency

String

False

The currency for the budget.

ManageUrl

String

True

A link to manage the marketing event, generally in the Shopify app's interface.

PreviewUrl

String

True

A link to view the live version of the post/ad, or to view a rendered preview of the post/ad/email in the Shopify app.

ReferringDomain

String

False

The destination domain of the marketing event. Required unless MarketingChannel is one of email/referral/display.

MarketedResources

String

True

A list of the items that were marketed in the marketing event. It's a list of dictionaries with type keys and id keys. Valid values for type are: (`product`, `collection`, `price_rule`, `page`, `article`, `homepage`). All types, other than homepage, also require an id.

StartedAt

Datetime

False

The timestamp when the marketing action was started, or when the email was sent, or when the Facebook post was made live, etc.

EndedAt

Datetime

False

For events with a duration, when the event actually ended. This may differ from ScheduledToEndAt, if the ad was stopped early, etc.

ScheduledToEndAt

Datetime

False

For events with a duration, when the event was supposed to end.

Last updated