Following Feeds

LAST EDIT Oct 08 2021

Following relationships are a fundamental part of social networks and many other apps that feature feeds. They link one Feed to another and cause Activities added to a feed to appear in any other feeds that follow it.

When an Activity is added to a feed, it is automatically added to any other feeds that follow the feed. This does not propagate further through the graph of following relationships. If your app requires that the Activity be added to other feeds, "to" field targeting or a batch activity add may be suitable.

The code example below shows you how to follow a feed:

Also take note that:

Only Flat Feeds may be followed
A Feed cannot follow itself

By default, the most recent 100 existing activities in the target feed will be added to the follower feed, but this can be changed via the activity_copy_limit parameter.

Parameters

Copied!
nametypedescriptiondefaultoptional
feedstringThe feed id-
targetstringThe feed id of the target feed-
activity_copy_limitintHow many activities should be copied from the target feed. max 1000-

If you need to follow many feeds at once have a look at how to batch follow later in this document. If you need to run large imports, use our JSON import format.

Unfollowing Feeds

Copied!

Unfollowing a feed removes the following relationship with the feed specified in the target parameter. See the following examples:

Existing Activities in the feed that originated in a no longer followed target feed will be purged unless the keep_history parameter is provided.

Parameters

Copied!
nametypedescriptiondefaultoptional
feedstringThe feed id-
targetstringThe feed id of the target feed-
keep_historybooleanWhether the activities from the unfollowed feeds should be removedfalse
Re-following a feed that is already followed has no effect. However, unfollowing and re-following a feed will result in feed updates as Activities are purged and re-added to the feed.

Reading Feed Followers

Copied!

Returns a paginated list of the given feed's followers. See the following example:

The followers returned by the API are sorted reverse chronologically, according to the time the follow relationship was created.

The number of followers that can be retrieved is limited to 1,000.

Parameters

Copied!
nametypedescriptiondefaultoptional
limitintegerAmount of results per request, max 10025
offsetintegerNumber of rows to skip before returning results, max 9990

Response Data

Copied!

Reading Followed Feeds

Copied!

Returns a paginated list of the feeds which are followed by the feed. See the following example:

The followed feeds returned by the API are sorted reverse chronologically, according to the time the follow relationship was created.

The number of followed feeds that can be retrieved is limited to 1,000.

Parameters

Copied!
nametypedescriptiondefaultoptional
limitintegerAmount of results per request, max 10025
offsetintegerNumber of rows to skip before returning results, max 9990
filterstringThe comma-separated list of feeds to filter results on-

Response Data

Copied!

Reading follow stats

Copied!

Paginating followers and/or followings is sometimes not the answer and only counts are needed. In this case, stats can be retrieved directly too. With default permissions, it works automatically for server side auth. For client-side auth, please contact support to add it to your required feed groups.

Counts are up to 10K. If a feed has more followers or followings than this number, please contact support to increase limits.

Response Data

Copied!