The type of an object. Can be any one of our predefined types. Although it is flexible what object type you use, as a best practice, we suggest you pick the one that relates best to the data you are representing. Doing this also allows specific algos to automatically work with their default settings.

The id of your object. The id can be a string (up to 40 characters) containing any number, alpha character, spaces, or the following special characters: @-!#%^&()/+=;:'"?<>][{}.,

The type of relationship for an event. Can be any one of our predefined types. Although it is flexible what relationship type you use, as a best practice, we suggest you pick the one that relates best to the data you are representing. Doing this also allows specific algos to automatically work with their default settings.

Whether the relationship can be duplicated or not. If single is true (default), then a relationship of each type can only exist once between the same start and end objects. If false, a relationship of the same type can exist multiple times between the same start and end objects.

The type of an object. Can be any one of our predefined types. Although it is flexible what object type you use, as a best practice, we suggest you pick the one that relates best to the data you are representing. Doing this also allows specific algos to automatically work with their default settings.

The id of your object. The id can be a string (up to 40 characters) containing any number, alpha character, spaces, or the following special characters: @-!#%^&()/+=;:'"?<>][{}.,

Whether the event should be created asynchronously or synchronously. Default is false (asynchronous). On success, async will return 202 Accepted, sync will return 201 Created.

ID of the object you want to get an activity feed for.

Type of the object you want to get an activity feed for.

An array of the relationship types that represent the concept of "following" in your data. If none provided, by default the relationship type "followed" will be used.

An array of the object types that can be followed in your dataset and that you want to be used for this activity feed. If none provided, by default any object type that is found based on the allowed follow_relationship_types will be used.

An array of the relationship types of the actions you want to show up in the activity feed. If none provided, by default any relationships that are present in the resulting feed items will be returned.

An array of the object types that can appear as content in the feed. If none provided, any object type that results from the other settings will be shown in the feed.

If this value is false (the default), then the user you are fetching the feed for can appear in the feed results as an acting user (if the user follows themself) or action user (object that is being acted on by users the user follows). If set to true, the user the feed is being fetched for will not appear in the results.

If this value is false (the default), then trying to fetch an activity feed for a non-existent object will result in a 404 object not found error being returned. If this value is true, then in the case of a non-existent object, an empty activity feed will be returned with no error.

ID of the object you want to get activity on.

Type of the object you want to get activity on.

Relationship types to include in the fetched activity (will include all by default)

Direction of relationships to include in the acitivty on the specified object. If no direction is specified, activity event relationships of both directions will be returned.

ID of the object you want to get recommended users for.

Type of the object you want to get recommended users for.

The relationship type in your data that is used to represent a user (or other type) following someone else. If this value is not provided, it will default to "followed".

A relationship type that represents a user creating content in your data. If no value is provided, this will default to "posted".

The positive indicator a user can take on the content type that users can create. This should be the action a user can take that you consider most important to indicating that an object appeals to their tastes. If value is not provided, it will default to "liked".

Set this relationship to the relationship you use to set tags on the content that is created by users. If a value is not provided, "taggedWith" will be used by default.

The type of object that represents the content being created by users. If no value is provided, this defaults to "post".

Set this type to the object you use for tags on the content that is created by your users. If a value is not provided, "tag" will be used by default.

If this value is false (the default), then trying to fetch an activity feed for a non-existent object will result in a 404 object not found error being returned. If this value is true, then in the case of a non-existent object, an empty activity feed will be returned with no error.

ID of the object you want to get related tags for.

Type of the object you want to get related tags for.

The object type of the content associated to your tags. Ex. if the tags in your dataset are found on posts, then this value should be "post".

The relationship type that represents content being tagged in your set. If no value is provided, this will default to taggedWith.

Object ids that you want not to be included in the resulting tags (or whatever type target object is).

The type of an object. Can be any one of our predefined types. Although it is flexible what object type you use, as a best practice, we suggest you pick the one that relates best to the data you are representing. Doing this also allows specific algos to automatically work with their default settings.

The id of your object. The id can be a string (up to 40 characters) containing any number, alpha character, spaces, or the following special characters: @-!#%^&()/+=;:'"?<>][{}.,

The type of relationship for an event. Can be any one of our predefined types. Although it is flexible what relationship type you use, as a best practice, we suggest you pick the one that relates best to the data you are representing. Doing this also allows specific algos to automatically work with their default settings.

Whether the relationship can be duplicated or not. If single is true (default), then a relationship of each type can only exist once between the same start and end objects. If false, a relationship of the same type can exist multiple times between the same start and end objects.

The type of an object. Can be any one of our predefined types. Although it is flexible what object type you use, as a best practice, we suggest you pick the one that relates best to the data you are representing. Doing this also allows specific algos to automatically work with their default settings.

The id of your object. The id can be a string (up to 40 characters) containing any number, alpha character, spaces, or the following special characters: @-!#%^&()/+=;:'"?<>][{}.,

Whether the events should be created asynchronously or synchronously. Default is false (asynchronous)

ID of the object you want to get an activity for.

Type of the object you want to get an activity feed for.

An array of the relationship types that represent the concept of "following" in your data. If none provided, by default the relationship type "followed" will be used.

An array of the object types that can be followed in your dataset and that you want to be used for this activity feed. If none provided, by default any object type that is found based on the allowed follow_relationship_types will be used.

An array of the relationship types of the actions you want to show up in the activity feed. If none provided, by default any relationships that are present in the resulting feed items will be returned.

An array of the object types that can appear as content in the feed. If none provided, any object type that results from the other settings will be shown in the feed.

If this value is false (the default), then the user you are fetching the feed for can appear in the feed results as an acting user (if the user follows themself) or action user (object that is being acted on by users the user follows). If set to true, the user the feed is being fetched for will not appear in the results.

If this value is false (the default), then trying to fetch an activity feed for a non-existent object will result in a 404 object not found error being returned. If this value is true, then in the case of a non-existent object, an empty activity feed will be returned with no error.

ID of the object you want to get recommended content for.

Type of the object you want to get recommended content for.

The type of object that is being recommended.

The primary positive indicator a user can take on the content type that's being recommended. This should be the action a user can take that you consider most important to indicating that an object appeals to their tastes. If value is not provided, it will default to "liked".

The secondary positive indicator a user can take on the content type that's being recommended. This should be the action a user can take that you consider to be important in indicating that an object appeals to their tastes. It will be weighted less than the primary positive relationship type, but still taken into account. If value is not provided, it will default to "viewed".

The primary negative action a user can take on the content type. This should be the action a user can take that you consider to be important in indicating that an object does not appeal to their tastes. Content that the user marked with this type will not be returned in recommendation results. If value is not provided, it will default to "disliked".

Set this relationship to the relationship you use to set tags on the content that is being recommended. If a value is not provided, "taggedWith" will be used by default.

Set this relationship to the object you use for tags on the content that is being recommended. If a value is not provided, "tag" will be used by default.

You can use this option to provide some ids of tags you want to contribute to coldstart recommendations if no real recommendations are yet available for a user. If you provide one or more tag ids for this field, trending content from those tags will be used as coldstart recommendations when personalized recommendations are not available.

Default value is false. If set to true, an array called authors will be provided with each item, providing the authors of the recommended content. If this is set to true, then content_created_relationship_type must also be set.

A relationship type that represents a user creating content in your data. Required if include_content_authors or exclude_content_from_followed is set to true.

Default value is false. If set to true, content that was created by authors that the user follows will be excluded. If set to true, content_created_relationship_type must also be set.

A relationship type that represents a user following another user in your data. If exclude_content_from_followed is set to true and this value is not set, then it will default to followed.

ID of the object you want to get related content for.

Type of the object you want to get related content for.

The relationship type that represents content being tagged with a tag in your data. If not provided, then tags will not be considered in this algo.

The object type that represents a tag in your data. If not provided, and content tagged relationship type was provided, this will default to "tag".

The relationship of a positive action that users (or whatever actor type) can take on the content type. If the value is not provided, then collaborative filtering will not be used in the algo.

The type of the object that acts on the target content (ex. user). If this value is not provided, and positive rel is set, then this will default to "user".

ID of the object you want to get related users for.

Type of the object you want to get related users for.

The relationship type used to represent a user following another user. If this value is not provided, then collabrative filtering will not be used for the algo.

The relationship type that represents content (created by users) being tagged. If this value is not provided, then tag data will not be used for the algo.

The object tyoe that represents a tag for the content a user can publish. If this value is not set, and content tagged relationship type has been set, then this will default to "tag".

Object type of the content users publish. If this value is not set, and content tagged relationship type has been set, then this value will default to "post".

The relationship type that represents a user publishing content. If this value is not set, and content tagged relationship type has been set, then this value will default to "posted".