Get all comments

Endpoint toGet all comments on toolzz analytics

GET /api/public/comments/{commentId}

Get all comments

cURL

curl --request GET \
  --url https://api.example.com/api/public/comments/{commentId}

200

{
  "data": [
    {
      "id": "<string>",
      "projectId": "<string>",
      "createdAt": {},
      "updatedAt": {},
      "objectType": "<string>",
      "objectId": "<string>",
      "content": "<string>",
      "authorUserId": "<string>"
    }
  ],
  "meta": {
    "page": 123,
    "limit": 123,
    "totalItems": 123,
    "totalPages": 123
  }
}

Request Description

page · integer | null

Page number, starts at 1. Nullable if no pagination is required.

limit · integer | null

Limit of items per page. Reduce size if API issues occur. Nullable if no limit is specified.

objectType · string | null

Filter comments by object type (e.g., trace, observation, session, prompt). Nullable if no filtering by object type is needed.

objectId · string | null

Filter comments by object ID. Required if objectType is provided; nullable otherwise.

authorUserId · string | null

Filter comments by the author user ID. Nullable if no filtering by author is needed.

Response Description

Below you will see the description of the get a list score response

data · array

Array of comment objects.

Show Comment Object

id · string · required

Unique identifier of the comment.

projectId · string · required

ID of the associated project.

createdAt · date-time · required

Timestamp of when the comment was created (ISO 8601 format).

updatedAt · date-time · required

Timestamp of when the comment was last updated (ISO 8601 format).

objectType · string · required

Type of object the comment is associated with (e.g., TRACE, OBSERVATION).

objectId · string · required

ID of the object the comment is associated with.

content · string · required

The content of the comment.

authorUserId · string · required

ID of the user who authored the comment.

meta · object

Metadata for pagination.

Show Meta Object

page · integer · required

Current page number.

limit · integer · required

Number of items per page.

totalItems · integer · required

Total number of items available.

totalPages · integer · required

Total number of pages available.

Code Response

Exemples of Response Code

• 200 Successful Response Code
• 400 Error Response Code