live_help Notes

chrome_reader_mode This resource is paginated by 30 items

settings Params

Param name Description
event_id optional . Must be String

The event id

scale_team_id optional . Must be String

The scale_team id

sort optional . Must be one of: id, user_id, feedbackable_type, feedbackable_id, comment, rating, created_at, updated_at.

The sort field. Sorted by created_at asc, id desc by default.

Example:

To sort on feedbacks on the fields created_at on a descending order and updated_at on a ascending order:

...&sort=-created_at,updated_at

filter optional . Must be one of: id, user_id, feedbackable_type, feedbackable_id, comment, rating, created_at, updated_at, campus_id.

Filtering on one or more fields

Example:

To filter on feedbacks with the id field matching a_value or another_value:

...&filter[id]=a_value,another_value

Filterable fields:
  • id (standard field)
  • user_id (standard field)
  • feedbackable_type (standard field)
  • feedbackable_id (standard field)
  • comment (standard field)
  • rating (standard field)
  • created_at (standard field)
  • updated_at (standard field)
  • campus_id : Only return feedbacks of specific campus. Can be one of: 1, 2, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61
range optional . Must be one of: id, user_id, feedbackable_type, feedbackable_id, comment, rating, created_at, updated_at.

Select on a particular range

Example:

To range on feedbacks with the updated_at field between min_value and max_value:

...&range[updated_at]=min_value,max_value

Rangeable fields:
  • id
  • user_id
  • feedbackable_type
  • feedbackable_id
  • comment
  • rating
  • created_at
  • updated_at
page optional . Must be a Hash

The pagination params, as a hash

page[number] optional . Must be Fixnum

The current page

page[size] optional . Must be Fixnum

The number of items per page, defaults to 30, maximum 100