marketingActivities - admin-graphql - QUERY

Version: 2025-01

Description:

A list of marketing activities associated with the marketing app.

Access Scopes

Arguments

  • after: String - The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
  • before: String - The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
  • first: Int - The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
  • last: Int - The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
  • marketingActivityIds: ID - The list of marketing activity IDs to filter by.
  • query: String - A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | default | string | Filter by a case-insensitive search of multiple fields in a document. | | | - `query=Bob Norman`<br/> - `query=title:green hoodie` | | app_id | id | | app_name | string | A comma-separated list of app names. | | created_at | time | | id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` | | marketing_campaign_id | id | | scheduled_to_end_at | time | | scheduled_to_start_at | time | | tactic | string | | title | string | | updated_at | time | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).
  • remoteIds: String - The list of remote IDs associated with marketing activities to filter by.
  • reverse: Boolean - Reverse the order of the underlying list.
  • savedSearchId: ID - The ID of a [saved search](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch#field-id). The search’s query string is used as the query argument.
  • sortKey: MarketingActivitySortKeys - 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).
  • utm: UTMInput - The UTM parameters associated with marketing activities to filter by.

Returns

  • edges: MarketingActivityEdge! The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
  • nodes: MarketingActivity! A list of nodes that are contained in MarketingActivityEdge. 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.
  • pageInfo: PageInfo! An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page.

Examples