Get Recommended Users to Follow (for user)

get

https://api.pipeless.io/v1/apps/{app_id}/algos/recommendations/users-to-follow

For a given user (or any object type), get a list of recommended users for the target user to follow, based on their behavior/tastes.

Path Params

app_id

string

required

Defaults to 123

Body Params

object

required

followed_relationship_type

string

enum

Defaults to followed

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".

content_created_relationship_type

string

enum

Defaults to posted

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

positive_relationship_type

string

enum

Defaults to liked

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".

content_tagged_relationship_type

string

enum

Defaults to taggedWith

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.

content_object_type

string

enum

Defaults to article

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

content_tag_object_type

string

enum

Defaults to tag

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.

dismissed_relationship_type

string

enum

A relationship type that represents a user dismissing the recommendation of a piece of content in your data. If this param is not provided, it defaults to "dismissed".

allow_missing_object

boolean

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.

limit

integer

Responses

200OK

400Bad Request

404Not Found