Select your Platform:
Reactions
Confused about "Reactions"?
Let us know how we can improve our documentation:
Adding Reactions
Copied!Confused about "Adding Reactions"?
Let us know how we can improve our documentation:
Reactions are a special kind of data that can be used to capture user interaction with specific activities. Common examples of reactions are likes, comments, and upvotes. Reactions are automatically returned to feeds' activities at read time when the reactions parameters are used.
Reactions are always related to activities; in order to add a reaction to an activity you need to provide its ID.
Parameters
Copied!Confused about "Parameters"?
Let us know how we can improve our documentation:
| name | type | description | default | optional |
|---|---|---|---|---|
| kind | string | The type of reaction (eg. like, comment, ...) | - | |
| activity_id | string | The ID of the activity the reaction refers to | - | |
| data | object | Additional data to attach to the reaction | - | ✓ |
target_feeds | array | The feeds that should receive a notification activity | - | ✓ |
| target_feeds_extra_data | object | Additional data to attach to the notification activities | - | ✓ |
| user_id | string | Id of the user adding the reaction if not own user. Required for server side. | - | ✓ |
Here's a complete example:
Retrieving Reactions
Copied!Confused about "Retrieving Reactions"?
Let us know how we can improve our documentation:
You can read reactions and filter them based on their user_id or activity_id values.
Further filtering can be done with the kind parameter (e.g. retrieve all likes by one user, retrieve all comments for one activity, etc.).
Reactions are returned in descending order (newest to oldest) by default and when using id_lt[e] , and in ascending order (oldest to newest) when using id_gt[e].
Parameters
Copied!Confused about "Parameters"?
Let us know how we can improve our documentation:
| name | type | description | default | optional |
|---|---|---|---|---|
| activity_id | string | Retrieve reactions by activity_id | - | |
| user_id | string | Retrieve reactions by user_id | - | |
| reaction_id | string | Retrieve children reaction by reaction_id | - | ✓ |
| kind | string | If provided it will only retrieve reactions of a certain kind (e.g. "like") | - | ✓ |
| limit | integer | The number of reactions to retrieve (Max. 25) | 10 | ✓ |
| id_gte | string | Retrieve reactions created after the one with ID equal to the parameter (inclusive) | - | ✓ |
| id_gt | string | Retrieve reactions created after the one with ID equal to the parameter. | - | ✓ |
| id_lte | string | Retrieve reactions created before the one with ID equal to the parameter (inclusive) | - | ✓ |
| id_lt | string | Retrieve reactions before the one with ID equal to the parameter | - | ✓ |
| with_activity_data | boolean | Returns activity data when paginating using activity_id | - | ✓ |
| with_own_children | boolean | Enable returning the children reactions when filtering reactions by parent ID | - | ✓ |
Retrieving Reactions by ID
Copied!Confused about "Retrieving Reactions by ID"?
Let us know how we can improve our documentation:
Updating Reactions
Copied!Confused about "Updating Reactions"?
Let us know how we can improve our documentation:
Reactions can be updated by providing reaction ID parameter. Changes to reactions are propagated to all notified feeds; if the target_feeds list is updated, notifications will be added and removed accordingly.
Parameters
Copied!Confused about "Parameters"?
Let us know how we can improve our documentation:
| name | type | description | default | optional |
|---|---|---|---|---|
| reaction_id | string | The ID of the reaction | - | |
| data | object | Reaction data | - | ✓ |
| target_feeds | string | The list of feeds that should receive a copy of the reaction. | - | ✓ |
Removing Reactions
Copied!Confused about "Removing Reactions"?
Let us know how we can improve our documentation:
Reactions are easy to remove. Simply pass in their ID, like so:
Soft delete and restore.
Copied!Confused about "Soft delete and restore."?
Let us know how we can improve our documentation:
Reactions can be soft deleted and restored by ID:
