List blog comments
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/blog/comments?filters=%5B%7B%22field%22%3A%22is_approved%22%2C%22operator%22%3A%22is%22%2C%22values%22%3A%5B%22false%22%5D%7D%5D&sort_order=asc';const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://apibase.ecomweb.app/api/v1/stores/example/blog/comments?filters=%5B%7B%22field%22%3A%22is_approved%22%2C%22operator%22%3A%22is%22%2C%22values%22%3A%5B%22false%22%5D%7D%5D&sort_order=asc' \ --header 'x-api-key: <x-api-key>'Returns comments on all of the store’s posts, newest first by default, each with the title of its post. Filter by approval state, post or text, or pass filters for list-view filters. Paginated with limit (default 20) and offset.
Required scopes: read:blog
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Query Parameters
Section titled “Query Parameters”Return only approved (true) or only pending (false) comments.
Return only comments on the post with this ID.
Free-text search over commenter name, email and comment text.
Maximum number of comments to return. Defaults to 20.
Number of comments to skip. Defaults to 0.
Example
[{"field":"is_approved","operator":"is","values":["false"]}]Admin list-view filters, a JSON array of {field, operator, values}. At most 10 clauses, at most 50 values each.
Sort field
Sort direction.
Responses
Section titled “Responses”object
object
Comment ID.
ID of the post the comment belongs to.
ID of the comment this one replies to, or null for a top-level comment.
Name of the commenter.
Email of the commenter.
Website of the commenter, or null.
Comment text.
Whether the comment is approved and visible on the storefront.
When the comment was created, as an ISO 8601 timestamp.
Title of the post the comment belongs to. Present on the store-wide comment list only.
object
Total number of items matching the request.
Maximum number of items in this page.
Number of items skipped before this page.
Current page number, starting at 1.
Total number of pages.
Whether a next page exists.
Whether a previous page exists.
Example generated
{ "data": [ { "id": 1, "blog_post_id": 1, "parent_comment_id": 1, "author_name": "example", "author_email": "example", "author_website": "example", "content": "example", "is_approved": true, "created_at": "example", "post_title": "example" } ], "meta": { "total": 1, "limit": 1, "offset": 1, "page": 1, "totalPages": 1, "hasNext": true, "hasPrev": true }}The request is malformed or failed validation.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}