Choose a version:

events

query

The paginated list of events associated with the store.

EventConnection arguments

•EventConnection

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 action •string: The action that occured.
Anchor to comments •boolean: Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.
Anchor to created_at •time: Filter by the date and time when the event happened.
Anchor to id •id: Filter by id range.
Anchor to subject_type •string: The resource type affected by this event. See EventSubjectType for possible values.

reverse

•BooleanDefault:false

Reverse the order of the underlying list.

sortKey

•EventSortKeysDefault: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 •[EventEdge!]!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 •[Event!]!non-null: A list of nodes that are contained in EventEdge. 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?

Retrieve the first 10 destroy events for products
Retrieve the first 10 events after a given time
Retrieve the first 10 events for products including comment events
Retrieves a list of events

Examples

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query {

events(query: "action:'destroy' AND subject_type:'PRODUCT'", first: 10) {

edges {

node {

message

... on BasicEvent {

action

subjectType

subject {

__typename

}

}`,

);

const data = await response.json();

query {
  events(query: "action:'destroy' AND subject_type:'PRODUCT'", first: 10) {
    edges {
      node {
        id
        message
        ... on BasicEvent {
          action
          subjectType
          subject {
            __typename
          }
        }
      }
    }
  }
}

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 { events(query: \"action:'\''destroy'\'' AND subject_type:'\''PRODUCT'\''\", first: 10) { edges { node { id message ... on BasicEvent { action subjectType subject { __typename } } } } } }"
}'

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

const response = await admin.graphql(
  `#graphql
  query {
    events(query: "action:'destroy' AND subject_type:'PRODUCT'", first: 10) {
      edges {
        node {
          id
          message
          ... on BasicEvent {
            action
            subjectType
            subject {
              __typename
            }
          }
        }
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    events(query: "action:'destroy' AND subject_type:'PRODUCT'", first: 10) {
      edges {
        node {
          id
          message
          ... on BasicEvent {
            action
            subjectType
            subject {
              __typename
            }
          }
        }
      }
    }
  }`,
});

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 {
    events(query: "action:'destroy' AND subject_type:'PRODUCT'", first: 10) {
      edges {
        node {
          id
          message
          ... on BasicEvent {
            action
            subjectType
            subject {
              __typename
            }
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"events": {

"edges": [

{

"node": {

"id": "gid://shopify/BasicEvent/625930779",

"message": "Product was deleted: Dandy Googles (Blue).",

"action": "destroy",

"subjectType": "PRODUCT",

"subject": {

"__typename": "Product"

}

]

}