Choose a version:

marketingEvents

query

A list of marketing events associated with the marketing app.

MarketingEventConnection arguments

•MarketingEventConnection!

after

•String

The elements that come after the specified cursor.

before

•String

The elements that come before the specified cursor.

first

•Int

The first n elements from the paginated list.

last

•Int

The last n elements from the paginated list.

query

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to app_id •id
Anchor to description •string
Anchor to id •id: Filter by id range.
Anchor to started_at •time
Anchor to type •string

reverse

•Boolean

Default:false

Reverse the order of the underlying list.

sortKey

•MarketingEventSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges •[MarketingEventEdge!]! non-null: The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
Anchor to nodesnodes •[MarketingEvent!]! non-null: A list of nodes that are contained in MarketingEventEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
Anchor to pageInfopageInfo •PageInfo! non-null: An object that’s used to retrieve cursor information about the current page.

Was this section helpful?

Examples

Retrieves a list of all marketing events

Query

query MarketingEventList {
  marketingEvents(first: 10) {
    edges {
      node {
        id
        type
        remoteId
        startedAt
        endedAt
        scheduledToEndAt
        manageUrl
        previewUrl
        utmCampaign
        utmMedium
        utmSource
        description
        marketingChannelType
        sourceAndMedium
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query MarketingEventList { marketingEvents(first: 10) { edges { node { id type remoteId startedAt endedAt scheduledToEndAt manageUrl previewUrl utmCampaign utmMedium utmSource description marketingChannelType sourceAndMedium } } pageInfo { hasNextPage endCursor } } }"
}'

Remix

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query MarketingEventList {
    marketingEvents(first: 10) {
      edges {
        node {
          id
          type
          remoteId
          startedAt
          endedAt
          scheduledToEndAt
          manageUrl
          previewUrl
          utmCampaign
          utmMedium
          utmSource
          description
          marketingChannelType
          sourceAndMedium
        }
      }
      pageInfo {
        hasNextPage
        endCursor
      }
    }
  }`,
);

const data = await response.json();

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query MarketingEventList {
    marketingEvents(first: 10) {
      edges {
        node {
          id
          type
          remoteId
          startedAt
          endedAt
          scheduledToEndAt
          manageUrl
          previewUrl
          utmCampaign
          utmMedium
          utmSource
          description
          marketingChannelType
          sourceAndMedium
        }
      }
      pageInfo {
        hasNextPage
        endCursor
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query MarketingEventList {
    marketingEvents(first: 10) {
      edges {
        node {
          id
          type
          remoteId
          startedAt
          endedAt
          scheduledToEndAt
          manageUrl
          previewUrl
          utmCampaign
          utmMedium
          utmSource
          description
          marketingChannelType
          sourceAndMedium
        }
      }
      pageInfo {
        hasNextPage
        endCursor
      }
    }
  }`,
});

Response

{
  "marketingEvents": {
    "edges": [
      {
        "node": {
          "id": "gid://shopify/MarketingEvent/40997430",
          "type": "AD",
          "remoteId": "2345:6789",
          "startedAt": "2012-01-01T00:00:00Z",
          "endedAt": null,
          "scheduledToEndAt": null,
          "manageUrl": null,
          "previewUrl": null,
          "utmCampaign": "1234567899",
          "utmMedium": "facebook-ad",
          "utmSource": "facebook",
          "description": null,
          "marketingChannelType": "SOCIAL",
          "sourceAndMedium": "Facebook ad"
        }
      },
      {
        "node": {
          "id": "gid://shopify/MarketingEvent/56540067",
          "type": "NEWSLETTER",
          "remoteId": "222",
          "startedAt": "2024-11-17T20:47:51Z",
          "endedAt": null,
          "scheduledToEndAt": null,
          "manageUrl": "https://example.com",
          "previewUrl": "https://example.com/image.png",
          "utmCampaign": null,
          "utmMedium": null,
          "utmSource": null,
          "description": "External Marketing Activity Campaign",
          "marketingChannelType": "DISPLAY",
          "sourceAndMedium": "Display newsletter"
        }
      },
      {
        "node": {
          "id": "gid://shopify/MarketingEvent/151661601",
          "type": "NEWSLETTER",
          "remoteId": null,
          "startedAt": "2024-11-08T20:47:51Z",
          "endedAt": null,
          "scheduledToEndAt": null,
          "manageUrl": null,
          "previewUrl": null,
          "utmCampaign": "email-for-deleted-automation",
          "utmMedium": "newsletter",
          "utmSource": "email",
          "description": null,
          "marketingChannelType": "EMAIL",
          "sourceAndMedium": "Email newsletter"
        }
      },
      {
        "node": {
          "id": "gid://shopify/MarketingEvent/178808684",
          "type": "AD",
          "remoteId": null,
          "startedAt": "2012-01-01T00:00:00Z",
          "endedAt": null,
          "scheduledToEndAt": null,
          "manageUrl": null,
          "previewUrl": null,
          "utmCampaign": "google-shopping",
          "utmMedium": "ad",
          "utmSource": "google",
          "description": null,
          "marketingChannelType": "SEARCH",
          "sourceAndMedium": "Google ad"
        }
      },
      {
        "node": {
          "id": "gid://shopify/MarketingEvent/179113300",
          "type": "ABANDONED_CART",
          "remoteId": null,
          "startedAt": "2024-11-03T20:47:51Z",
          "endedAt": null,
          "scheduledToEndAt": null,
          "manageUrl": null,
          "previewUrl": null,
          "utmCampaign": "shopify_abandoned_checkout_email-1519754247",
          "utmMedium": "email",
          "utmSource": "abandoned_cart",
          "description": null,
          "marketingChannelType": "EMAIL",
          "sourceAndMedium": "Abandoned cart email"
        }
      },
      {
        "node": {
          "id": "gid://shopify/MarketingEvent/216774463",
          "type": "NEWSLETTER",
          "remoteId": "333",
          "startedAt": "2024-11-17T20:47:51Z",
          "endedAt": null,
          "scheduledToEndAt": null,
          "manageUrl": "https://example.com",
          "previewUrl": "https://example.com/image.png",
          "utmCampaign": null,
          "utmMedium": null,
          "utmSource": null,
          "description": "External Marketing Activity Ad Group",
          "marketingChannelType": "DISPLAY",
          "sourceAndMedium": "Display newsletter"
        }
      },
      {
        "node": {
          "id": "gid://shopify/MarketingEvent/264437935",
          "type": "NEWSLETTER",
          "remoteId": "444",
          "startedAt": "2024-11-17T20:47:51Z",
          "endedAt": null,
          "scheduledToEndAt": null,
          "manageUrl": "https://example.com",
          "previewUrl": "https://example.com/image.png",
          "utmCampaign": null,
          "utmMedium": null,
          "utmSource": null,
          "description": "External Marketing Activity Ad",
          "marketingChannelType": "DISPLAY",
          "sourceAndMedium": "Display newsletter"
        }
      },
      {
        "node": {
          "id": "gid://shopify/MarketingEvent/283266064",
          "type": "AD",
          "remoteId": null,
          "startedAt": "2012-01-01T00:00:00Z",
          "endedAt": null,
          "scheduledToEndAt": null,
          "manageUrl": null,
          "previewUrl": null,
          "utmCampaign": "google-shopping-4",
          "utmMedium": "ad",
          "utmSource": "google",
          "description": "Marketing Activity 4 for Snowdevil",
          "marketingChannelType": "SEARCH",
          "sourceAndMedium": "Google ad"
        }
      },
      {
        "node": {
          "id": "gid://shopify/MarketingEvent/325573600",
          "type": "POST",
          "remoteId": "1234:56779989",
          "startedAt": "2024-11-17T20:47:51Z",
          "endedAt": null,
          "scheduledToEndAt": null,
          "manageUrl": null,
          "previewUrl": null,
          "utmCampaign": "123456789000",
          "utmMedium": "facebook-post",
          "utmSource": "facebook",
          "description": null,
          "marketingChannelType": "SOCIAL",
          "sourceAndMedium": "Facebook post"
        }
      },
      {
        "node": {
          "id": "gid://shopify/MarketingEvent/425025702",
          "type": "NEWSLETTER",
          "remoteId": null,
          "startedAt": "2024-11-08T20:47:51Z",
          "endedAt": null,
          "scheduledToEndAt": null,
          "manageUrl": null,
          "previewUrl": null,
          "utmCampaign": "asdf",
          "utmMedium": "newsletter",
          "utmSource": "email",
          "description": null,
          "marketingChannelType": "EMAIL",
          "sourceAndMedium": "Email newsletter"
        }
      }
    ],
    "pageInfo": {
      "hasNextPage": true,
      "endCursor": "eyJsYXN0X2lkIjo0MjUwMjU3MDIsImxhc3RfdmFsdWUiOiI0MjUwMjU3MDIifQ=="
    }
  }
}

Retrieves a list of all marketing events

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query MarketingEventList {

marketingEvents(first: 10) {

edges {

node {

type

remoteId

startedAt

endedAt

scheduledToEndAt

manageUrl

previewUrl

utmCampaign

utmMedium

utmSource

description

marketingChannelType

sourceAndMedium

}

pageInfo {

hasNextPage

endCursor

}

}`,

);

const data = await response.json();

query MarketingEventList {
  marketingEvents(first: 10) {
    edges {
      node {
        id
        type
        remoteId
        startedAt
        endedAt
        scheduledToEndAt
        manageUrl
        previewUrl
        utmCampaign
        utmMedium
        utmSource
        description
        marketingChannelType
        sourceAndMedium
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query MarketingEventList { marketingEvents(first: 10) { edges { node { id type remoteId startedAt endedAt scheduledToEndAt manageUrl previewUrl utmCampaign utmMedium utmSource description marketingChannelType sourceAndMedium } } pageInfo { hasNextPage endCursor } } }"
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query MarketingEventList {
    marketingEvents(first: 10) {
      edges {
        node {
          id
          type
          remoteId
          startedAt
          endedAt
          scheduledToEndAt
          manageUrl
          previewUrl
          utmCampaign
          utmMedium
          utmSource
          description
          marketingChannelType
          sourceAndMedium
        }
      }
      pageInfo {
        hasNextPage
        endCursor
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query MarketingEventList {
    marketingEvents(first: 10) {
      edges {
        node {
          id
          type
          remoteId
          startedAt
          endedAt
          scheduledToEndAt
          manageUrl
          previewUrl
          utmCampaign
          utmMedium
          utmSource
          description
          marketingChannelType
          sourceAndMedium
        }
      }
      pageInfo {
        hasNextPage
        endCursor
      }
    }
  }`,
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query MarketingEventList {
    marketingEvents(first: 10) {
      edges {
        node {
          id
          type
          remoteId
          startedAt
          endedAt
          scheduledToEndAt
          manageUrl
          previewUrl
          utmCampaign
          utmMedium
          utmSource
          description
          marketingChannelType
          sourceAndMedium
        }
      }
      pageInfo {
        hasNextPage
        endCursor
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"marketingEvents": {

"edges": [

{

"node": {

"id": "gid://shopify/MarketingEvent/40997430",

"type": "AD",

"remoteId": "2345:6789",

"startedAt": "2012-01-01T00:00:00Z",

"endedAt": null,

"scheduledToEndAt": null,

"manageUrl": null,

"previewUrl": null,

"utmCampaign": "1234567899",

"utmMedium": "facebook-ad",

"utmSource": "facebook",

"description": null,

"marketingChannelType": "SOCIAL",

"sourceAndMedium": "Facebook ad"

}

{

"node": {

"id": "gid://shopify/MarketingEvent/56540067",

"type": "NEWSLETTER",

"remoteId": "222",

"startedAt": "2024-11-17T20:47:51Z",

"endedAt": null,

"scheduledToEndAt": null,

"manageUrl": "https://example.com",

"previewUrl": "https://example.com/image.png",

"utmCampaign": null,

"utmMedium": null,

"utmSource": null,

"description": "External Marketing Activity Campaign",

"marketingChannelType": "DISPLAY",