marketingEvents

A list of marketing events associated with the marketing app.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the marketingEvents action (under Marketing).
Fill in the fields below, then reference the result from later steps as {{marketingevents.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

query MarketingEvents($first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean, $sortKey: MarketingEventSortKeys, $query: String) {
  marketingEvents(
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
    sortKey: $sortKey
    query: $query
  ) {
    edges {
      cursor
      node {
        app
        channel
        channelHandle
        description
        endedAt
        id
        legacyResourceId
        manageUrl
        marketingChannelType
        previewUrl
        remoteId
        scheduledToEndAt
        sourceAndMedium
        startedAt
        targetTypeDisplayText
        type
        utmCampaign
        utmMedium
        utmSource
      }
    }
    nodes {
      app {
        apiKey
        appStoreAppUrl
        appStoreDeveloperUrl
        availableAccessScopes
        banner
        description
        developerName
        developerType
        developerUrl
        embedded
        failedRequirements
        features
        feedback
        handle
        icon
        id
        installUrl
        installation
        isPostPurchaseAppInUse
        launchUrl
        navigationItems
        optionalAccessScopes
        previouslyInstalled
        pricingDetails
        pricingDetailsSummary
        privacyPolicyUrl
        publicCategory
        published
        requestedAccessScopes
        screenshots
        shopifyDeveloped
        title
        uninstallMessage
        uninstallUrl
        webhookApiVersion
      }
      channel
      channelHandle
      description
      endedAt
      id
      legacyResourceId
      manageUrl
      marketingChannelType
      previewUrl
      remoteId
      scheduledToEndAt
      sourceAndMedium
      startedAt
      targetTypeDisplayText
      type
      utmCampaign
      utmMedium
      utmSource
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

firstnumber

The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

afterstring

The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

lastnumber

The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

beforestring

The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

reverseboolean

Reverse the order of the underlying list.

sortKeystring

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](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).

One ofIDSTARTED_AT

querystring

A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | app_id | id | | description | string | | id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` | | started_at | time | | type | string | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).

json

{
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false,
  "sortKey": "ID",
  "query": "string"
}

Response

Read the result with {{marketingevents.response.data.data.marketingEvents}}. If the API returns errors, the step fails and they are at {{marketingevents.response.data.errors}}.

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

appobject

channelobject

channelHandleobject

descriptionobject

endedAtobject

idobject

legacyResourceIdobject

manageUrlobject

marketingChannelTypeobject

previewUrlobject

remoteIdobject

scheduledToEndAtobject

sourceAndMediumobject

startedAtobject

targetTypeDisplayTextobject

typeobject

utmCampaignobject

utmMediumobject

utmSourceobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?