marketingEvents
A list of marketing events associated with the marketing app.
MarketingEventConnection arguments
- Anchor to afterafter•
The elements that come after the specified cursor.
- Anchor to beforebefore•
The elements that come before the specified cursor.
- Anchor to firstfirst•
The first
n
elements from the paginated list.- Anchor to lastlast•
The last
n
elements from the paginated list.- Anchor to queryquery•
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 reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•
Key MarketingEvent Default:IDSort Keys 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.
Anchor to Possible returnsPossible returns
- Anchor to edgesedges•[Marketing
Event non-nullEdge!]! The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
- Anchor to nodesnodes•[Marketing
Event!]! 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 pageInfopage•
Info PageInfo! non-null An object that’s used to retrieve cursor information about the current page.
Retrieves a list of all marketing events
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/2025-01/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)