CData Python Connector for Shopify

Build 25.0.9454

MarketingEvents

Lists marketing activities and campaigns created by apps, including type, channel, and performance status.

View-Specific Information

Select

The connector uses the Shopify API to process WHERE clause conditions built with the following columns and operators. The connector processes other filters client-side within the connector.

  • Id supports the '=, IN' comparison operators.
  • AppId supports the '=, !=' comparison operators.
  • Type supports the '=, !=' comparison operators.
  • StartedAt supports the '=, !=, <, >, >=, <=' comparison operators.

For example, the following queries are processed server-side:

  SELECT * FROM MarketingEvents WHERE Id = 'Val1'
  SELECT * FROM MarketingEvents WHERE AppId = 'Val1'
  SELECT * FROM MarketingEvents WHERE Type = 'Val1'
  SELECT * FROM MarketingEvents WHERE StartedAt = '2023-01-01 11:10:00'

Columns

Name Type References Description
Id [KEY] String A unique identifier for the marketing event record.
RemoteId String An optional identifier used to validate engagement data received from external marketing systems.
LegacyResourceId String The identifier for the corresponding marketing event resource in the Shopify REST Admin API, maintained for backward compatibility.
AppId String A unique identifier for the app that created or manages this marketing event.
MarketingChannelType String The channel or medium through which the marketing activity reached consumers, such as email, social media, or paid search. Used for reporting and aggregation.
Description String A human-readable summary describing the purpose or content of the marketing event.
Type String The classification of the marketing event, identifying its nature or campaign type (for example, ad campaign or email blast).
EndedAt Datetime The date and time when the marketing event concluded or stopped running.
ManageUrl String The URL where the marketing event can be managed, such as within the app or platform that created it.
PreviewUrl String The URL for previewing the marketing event before or during execution.
StartedAt Datetime The date and time when the marketing event began.
UtmCampaign String The campaign name used in UTM tracking to associate the marketing event with a specific promotion or initiative.
UtmMedium String The UTM parameter indicating the medium used by the campaign, such as 'cpc', 'banner', or 'email'.
UtmSource String The UTM parameter identifying the traffic source or referrer of the marketing event, such as 'google' or 'newsletter'.
SourceAndMedium String A combined representation of the marketing source and medium, derived from 'marketingChannel', 'referringDomain', and 'type' to standardize cross-app reporting.
ScheduledToEndAt Datetime The scheduled date and time when the marketing event is planned to end, if applicable.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454