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 occurred. Event data is retained for 1 year.
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.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•EventSortKeys

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.

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to ipip

•String

The IP address of the commenter.

Anchor to isPublishedisPublished

•Boolean!

non-null

Whether or not the comment is published.

Anchor to publishedAtpublishedAt

•DateTime

The date and time when the comment was published.

Anchor to statusstatus

•CommentStatus!

non-null

The status of the comment.

Anchor to updatedAtupdatedAt

•DateTime

The date and time when the comment was last updated.

Anchor to userAgentuserAgent

•String

The user agent of the commenter.

Was this section helpful?

Examples

Retrieves a single comment by its ID

Query

query CommentShow($id: ID!) {
  comment(id: $id) {
    id
    body
    bodyHtml
    author {
      name
    }
    ip
    publishedAt
    status
    userAgent
  }
}

Variables

{
  "id": "gid://shopify/Comment/9450891"
}

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 CommentShow($id: ID!) { comment(id: $id) { id body bodyHtml author { name } ip publishedAt status userAgent } }",
 "variables": {
    "id": "gid://shopify/Comment/9450891"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query CommentShow($id: ID!) {
    comment(id: $id) {
      id
      body
      bodyHtml
      author {
        name
      }
      ip
      publishedAt
      status
      userAgent
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Comment/9450891"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

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 CommentShow($id: ID!) {
    comment(id: $id) {
      id
      body
      bodyHtml
      author {
        name
      }
      ip
      publishedAt
      status
      userAgent
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Comment/9450891"
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query CommentShow($id: ID!) {
      comment(id: $id) {
        id
        body
        bodyHtml
        author {
          name
        }
        ip
        publishedAt
        status
        userAgent
      }
    }`,
    "variables": {
        "id": "gid://shopify/Comment/9450891"
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'query CommentShow($id: ID!) {
  comment(id: $id) {
    id
    body
    bodyHtml
    author {
      name
    }
    ip
    publishedAt
    status
    userAgent
  }
}' \
--variables \
'{
  "id": "gid://shopify/Comment/9450891"
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query CommentShow($id: ID!) {
        comment(id: $id) {
          id
          body
          bodyHtml
          author {
            name
          }
          ip
          publishedAt
          status
          userAgent
        }
      }
    `,
    variables: {
        "id": "gid://shopify/Comment/9450891"
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "comment": {
    "id": "gid://shopify/Comment/9450891",
    "body": "Check my casino at ... This will be marked as spam by akismet, because of the author name.",
    "bodyHtml": "<p>Check my casino at ... This will be marked as spam by akismet, because of the author name.</p>",
    "author": {
      "name": "viagra-test-123"
    },
    "ip": "127.0.0.1",
    "publishedAt": null,
    "status": "SPAM",
    "userAgent": "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_4; en-us) AppleWebKit/525.18 (KHTML, like Gecko) Version/3.1.2 Safari/525.20.1"
  }
}

Retrieves a single comment by its ID

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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

const response = await admin.graphql(

`#graphql

query CommentShow($id: ID!) {

comment(id: $id) {

body

bodyHtml

author {

name

}

publishedAt

status

userAgent

}

}`,

{

variables: {

"id": "gid://shopify/Comment/9450891"

);

const json = await response.json();

return json.data;

}

GQL

query CommentShow($id: ID!) {
  comment(id: $id) {
    id
    body
    bodyHtml
    author {
      name
    }
    ip
    publishedAt
    status
    userAgent
  }
}

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 CommentShow($id: ID!) { comment(id: $id) { id body bodyHtml author { name } ip publishedAt status userAgent } }",
 "variables": {
    "id": "gid://shopify/Comment/9450891"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query CommentShow($id: ID!) {
    comment(id: $id) {
      id
      body
      bodyHtml
      author {
        name
      }
      ip
      publishedAt
      status
      userAgent
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Comment/9450891"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query CommentShow($id: ID!) {
      comment(id: $id) {
        id
        body
        bodyHtml
        author {
          name
        }
        ip
        publishedAt
        status
        userAgent
      }
    }`,
    "variables": {
        "id": "gid://shopify/Comment/9450891"
    },
  },
});

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 CommentShow($id: ID!) {
    comment(id: $id) {
      id
      body
      bodyHtml
      author {
        name
      }
      ip
      publishedAt
      status
      userAgent
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Comment/9450891"
}

response = client.query(query: query, variables: variables)

Shopify CLI

shopify app execute \
--query \
'query CommentShow($id: ID!) {
  comment(id: $id) {
    id
    body
    bodyHtml
    author {
      name
    }
    ip
    publishedAt
    status
    userAgent
  }
}' \
--variables \
'{
  "id": "gid://shopify/Comment/9450891"
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query CommentShow($id: ID!) {
        comment(id: $id) {
          id
          body
          bodyHtml
          author {
            name
          }
          ip
          publishedAt
          status
          userAgent
        }
      }
    `,
    variables: {
        "id": "gid://shopify/Comment/9450891"
    },
  }),
});

const { data } = await response.json();
console.log(data);

Input variables

JSON

{

"id": "gid://shopify/Comment/9450891"

}

Response

JSON

{

"comment": {

"id": "gid://shopify/Comment/9450891",

"body": "Check my casino at ... This will be marked as spam by akismet, because of the author name.",

"bodyHtml": "<p>Check my casino at ... This will be marked as spam by akismet, because of the author name.</p>",

"author": {

"name": "viagra-test-123"

"ip": "127.0.0.1",

"publishedAt": null,

"status": "SPAM",

"userAgent": "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_4; en-us) AppleWebKit/525.18 (KHTML, like Gecko) Version/3.1.2 Safari/525.20.1"

}