Skip to main content
Opik Documentation

Search documentation

Type to search this documentation.

Find Feedback definitions

GET/v1/private/feedback-definitionsFind Feedback definitions

Find Feedback definitions

Parameters

pageinteger · int32query

default 1 · minimum 1

sizeinteger · int32query

default 10 · minimum 1

namestringquery

Filter feedback definitions by name (partial match, case insensitive)

typestringquery

one of "numerical", "categorical", "boolean"

one of "numerical", "categorical", "boolean"

Responses

200Feedback definitions resourceapplication/json
objectFeedbackDefinitionPage_Public
contentarray of object
Show child attributes
Show array items
createdAtstring · date-time
createdBystring
descriptionstring

Optional description for the feedback definition

maxLength 255 · minLength 0

idstring · uuid
lastUpdatedAtstring · date-time
lastUpdatedBystring
namestringrequired

minLength 1

typestringrequired

one of "numerical", "categorical", "boolean"

pageinteger · int32
sizeinteger · int32
totalinteger · int64
Example response
{
  "content": [
    {
      "createdAt": "2026-06-09T00:00:00Z",
      "createdBy": "string",
      "description": "This feedback definition is used to rate response quality",
      "id": "00000000-0000-0000-0000-000000000000",
      "lastUpdatedAt": "2026-06-09T00:00:00Z",
      "lastUpdatedBy": "string",
      "name": "string",
      "type": "boolean"
    }
  ],
  "page": 0,
  "size": 0,
  "total": 0
}
Documentation menu