Builder API

Feedback

Retrieve message ratings from your Chipp app consumers

|View as Markdown
1 min read
#api#builder-api#rest#feedback#ratings#thumbs-up#thumbs-down

Feedback captures consumer ratings on individual messages. Consumers can rate assistant messages as positive (1) or negative (-1).

List Feedback

plaintext
GET /api/v1/apps/{appId}/feedback

Returns a paginated list of feedback entries, newest first. Uses offset-based pagination.

Query Parameters

ParameterTypeDefaultDescription
limitinteger25Results per page (1-100)
offsetinteger0Number of results to skip
ratinginteger—Filter by rating: -1 or 1
session_idUUID—Filter by session
created_afterISO 8601—Feedback created after this date
created_beforeISO 8601—Feedback created before this date

Example

bash
curl "https://build.chipp.ai/api/v1/apps/YOUR_APP_ID/feedback?limit=20" \
  -H "Authorization: Bearer chipp_YOUR_API_KEY"

Response

json
{
  "data": [
    {
      "id": "fb-001",
      "session_id": "550e8400-e29b-41d4-a716-446655440000",
      "message_id": "msg-002",
      "consumer_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "rating": 1,
      "message_preview": "Welcome! Here's how to get started...",
      "created_at": "2025-06-15T14:45:00Z"
    },
    {
      "id": "fb-002",
      "session_id": "660f9511-f30c-52e5-b827-557766551111",
      "message_id": "msg-014",
      "consumer_id": "8d0f7780-8536-51f6-c928-668877662222",
      "rating": -1,
      "message_preview": "I'm not sure about that. Let me...",
      "created_at": "2025-06-14T09:20:00Z"
    }
  ],
  "pagination": {
    "has_more": true,
    "total": 87,
    "limit": 20,
    "offset": 0
  }
}

Response Fields

FieldTypeDescription
idstringUnique feedback identifier
session_idUUIDThe session this feedback belongs to
message_idstringThe message that was rated
consumer_idUUID or nullThe consumer who submitted the feedback (null when it was not submitted by a consumer)
ratinginteger-1 (negative) or 1 (positive)
message_previewstring or nullTruncated preview of the rated message (max 200 characters). Null when the referenced message no longer exists, or when your organization has Zero Data Retention enabled
created_atISO 8601When the feedback was submitted

Filtering Negative Feedback

To find messages that need improvement:

bash
curl "https://build.chipp.ai/api/v1/apps/YOUR_APP_ID/feedback?rating=-1" \
  -H "Authorization: Bearer chipp_YOUR_API_KEY"

Feedback for a Specific Session

bash
curl "https://build.chipp.ai/api/v1/apps/YOUR_APP_ID/feedback?session_id=550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer chipp_YOUR_API_KEY"