comments - admin-graphql - QUERY

Version: 2024-10

Description:

List of the shop's comments.

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).
• 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` | | id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` | | published_status | string | Filter by published status | - `any`<br/> - `published`<br/> - `unpublished` | | - `published_status:any`<br/> - `published_status:published`<br/> - `published_status:unpublished` | | status | 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).
• reverse: Boolean - Reverse the order of the underlying list.
• sortKey: CommentSortKeys - 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).

Returns

• edges: CommentEdge! The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
• nodes: Comment! A list of nodes that are contained in CommentEdge. 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

• Retrieves a list of comments

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query CommentList { comments(first: 50) { nodes { id body bodyHtml author { name } ip publishedAt status userAgent } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query CommentList {\n    comments(first: 50) {\n      nodes {\n        id\n        body\n        bodyHtml\n        author {\n          name\n        }\n        ip\n        publishedAt\n        status\n        userAgent\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query CommentList {\n    comments(first: 50) {\n      nodes {\n        id\n        body\n        bodyHtml\n        author {\n          name\n        }\n        ip\n        publishedAt\n        status\n        userAgent\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query CommentList {\n    comments(first: 50) {\n      nodes {\n        id\n        body\n        bodyHtml\n        author {\n          name\n        }\n        ip\n        publishedAt\n        status\n        userAgent\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query CommentList {\n    comments(first: 50) {\n      nodes {\n        id\n        body\n        bodyHtml\n        author {\n          name\n        }\n        ip\n        publishedAt\n        status\n        userAgent\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query CommentList {\n  comments(first: 50) {\n    nodes {\n      id\n      body\n      bodyHtml\n      author {\n        name\n      }\n      ip\n      publishedAt\n      status\n      userAgent\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "comments": {
        "nodes": [
          {
            "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"
          },
          {
            "id": "gid://shopify/Comment/52127930",
            "body": "Hi author, I really _like_ what you're doing there.",
            "bodyHtml": "<p>Hi author, I really <em>like</em> what you're doing there.</p>",
            "author": {
              "name": "Soleone"
            },
            "ip": "127.0.0.1",
            "publishedAt": null,
            "status": "PENDING",
            "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"
          },
          {
            "id": "gid://shopify/Comment/64683838",
            "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": "PENDING",
            "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"
          },
          {
            "id": "gid://shopify/Comment/145356500",
            "body": "Great blog, love it!",
            "bodyHtml": "<p>Great blog, love it!</p>",
            "author": {
              "name": "Bob Bobsen"
            },
            "ip": "127.0.0.1",
            "publishedAt": null,
            "status": "PUBLISHED",
            "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"
          },
          {
            "id": "gid://shopify/Comment/757536350",
            "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": "UNAPPROVED",
            "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"
          }
        ]
      }
    }
  }