live_help Notes

chrome_reader_mode This resource is paginated by 30 items

settings Params

Param name Description
user_id required . Must be String

The user id or slug

sort optional . Must be one of: id, user_data_id, scale_team_id, reason, sum, created_at, updated_at, total.

The sort field. Sorted by id asc by default.

Example:

To sort on correction point historics on the fields updated_at on a descending order and total on a ascending order:

...&sort=-updated_at,total

filter optional . Must be one of: id, user_data_id, scale_team_id, reason, sum, created_at, updated_at, total.

Filtering on one or more fields

Example:

To filter on correction point historics with the id field matching a_value or another_value:

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

Filterable fields:
  • id (standard field)
  • user_data_id (standard field)
  • scale_team_id (standard field)
  • reason (standard field)
  • sum (standard field)
  • created_at (standard field)
  • updated_at (standard field)
  • total (standard field)
range optional . Must be one of: id, user_data_id, scale_team_id, reason, sum, created_at, updated_at, total.

Select on a particular range

Example:

To range on correction point historics with the total field between min_value and max_value:

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

Rangeable fields:
  • id
  • user_data_id
  • scale_team_id
  • reason
  • sum
  • created_at
  • updated_at
  • total
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