Following Feeds

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:

// timeline:timeline_feed_1 follows user:user_42
var timelineFeed1 = client.Feed("timeline", "timeline_feed_1");
await timelineFeed1.FollowFeedAsync("user", "user_42");

// follow feed without copying the activities:
await timelineFeed1.FollowFeedAsync("user", "user_42", 0);

// timeline:timeline_feed_1 follows user:user_42:
await timeline_feed_1.follow("user", "user_42");

// Follow feed without copying the activities:
await timeline_feed_1.follow("user", "user_42", { limit: 0 });

# timeline:timeline_feed_1 follows user:user_42
timeline_feed_1.follow("user", "user_42")

# Follow feed without copying the activities
timeline_feed_1.follow("user", "user_42", activity_copy_limit=0)

# timeline:timeline_feed_1 follows user:user_42
timeline_feed_1 = client.feed('timeline', 'timeline_feed_1')
timeline_feed_1.follow('user', 'user_42')

# follow feed without copying the activities:
timeline_feed_1.follow('user', 'user_42', activity_copy_limit=0)

// timeline:timeline_feed_1 follows user:user_42
$timeline1 = $client->feed('timeline', 'timeline_1');
$timeline1->follow('user', 'user_42');

// follow feed without copying the activities:
$timeline1->follow('user', 'user_42', 0)

// timeline:timeline_feed_1 follows user:user_42
FlatFeed user = client.flatFeed("user", "user_42");
FlatFeed timeline = client.flatFeed("timeline", "timeline_feed_1");
timeline.follow(user);

// follow feed without copying the activities:
timeline.follow(user, 0);

// timeline:timeline_feed_1 follows user:user_42
	userFeed, err := client.FlatFeed("user", "user_42")
	if err != nil {
		panic(err)
	}

	timeline, err := client.FlatFeed("timeline", "timeline_feed_1")
	if err != nil {
		panic(err)
	}

	_, err = timeline.Follow(context.TODO(), userFeed)
	if err != nil {
		panic(err)
	}

	// follow feed without copying all the activities:
	_, err = timeline.Follow(context.TODO(), userFeed, stream.WithFollowFeedActivityCopyLimit(20))
	if err != nil {
		panic(err)
	}

// A timeline feed for the current user.
let timelineFeed = Client.shared.flatFeed(feedSlug: "timeline")

// `timeline:current_user_id` follows `user:user_42`:
timelineFeed?.follow(toTarget: FeedId(feedSlug: "user", userId: "user_42")) { result in /* ... */ }

// Follow feed without copying the activities:
timelineFeed?.follow(toTarget: FeedId(feedSlug: "user", userId: "user_42"), activityCopyLimit: 0) { result in /* ... */ }

// timeline:timeline_feed_1 follows user:user_42:
final timelineFeed1 = client.flatFeed('timeline', 'timeline_feed_1');
final user42feed = client.flatFeed('user', 'user_42');
await timelineFeed1.follow(user42feed);

// Follow feed without copying the activities:
await timelineFeed1.follow(user42feed, activityCopyLimit: 0);

Also take note that:

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

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

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

var timelineFeed1 = client.Feed("timeline", "timeline_feed_1");

// stop following feed user_42
await timelineFeed1.UnfollowFeedAsync("user", "user_42");

// stop following feed 42 but keep history of activity

// Stop following feed user_42 - purging history:
await timeline_feed_1.unfollow("user", "user_42");

// Stop following feed user_42 but keep history of activities:
await timeline_feed_1.unfollow("user", "user_42", { keepHistory: true });

# Stop following feed user_42
timeline_feed_1.unfollow("user", "user_42")

# Stop following feed user_42 but keep history of activities
timeline_feed_1.unfollow("user", "user_42", keep_history=True)

# Stop following feed user_42
timeline_feed_1.unfollow('user', 'user_42')

# Stop following feed 42 but keep history of activities
timeline_feed_1.unfollow('user', 'user_42', keep_history=true)

// Stop following feed user_42
$timelineFeed1->unfollow('user', 'user_42');

// Stop following feed user_42 but keep history of activities:
$timelineFeed1->unfollow('user', 'user_42', true);

// Stop following feed user:user_42
timeline.unfollow(user);

// Stop following feed user:user_42 but keep history of activities
timeline.unfollow(user, KeepHistory.YES);

// Stop following feed user:user_42
	_, err = timeline.Unfollow(context.TODO(), userFeed)
	if err != nil {
		panic(err)
	}

	// Stop following feed user:42 but keep history of activities
	_, err = timeline.Unfollow(context.TODO(), userFeed, stream.WithUnfollowKeepHistory(true))
	if err != nil {
		panic(err)
	}

// Stop following feed user_42 - purging history:
timelineFeed?.unfollow(fromTarget: FeedId(feedSlug: "user", userId: "user_42")) { result in /* ... */ }

// Stop following feed user_42 but keep history of activities:
timelineFeed?.unfollow(fromTarget: FeedId(feedSlug: "user", userId: "user_42"), keepHistory: true) { result in /* ... */ }

// Stop following feed user_42 - purging history:
await timelineFeed1.unfollow(user42feed);

// Stop following feed user_42 but keep history of activities:
await timelineFeed1.unfollow(user42feed, keepHistory: true);

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

Reading Feed Followers

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

await userFeed1.FollowersAsync(0, 10);

// List followers
const response = await user1.followers({ limit: "10", offset: "10" });

# list followers
user_feed_1.followers(offset=0, limit=10)

# list followers
user_feed_1.followers(0, 10)

// list followers
$userFeed1->followers(0, 10);

// list followers
List<followrelation> followers = userFeed.getFollowers(new Limit(10), new Offset(0)).get();
for (FollowRelation follow : followers) {
  System.out.format("%s -&gt; %s", follow.getSource(), follow.getTarget());
  // ...
 }</followrelation>

resp, err := userFeed.GetFollowers(
 context.TODO(),
 stream.WithFollowersOffset(0),
 stream.WithFollowersLimit(10),
)
for _, follower := range resp.Results {
 fmt.Println(follower.FeedID, "-->", follower.TargetID)
		// ...
}

// The current user feed.
let userFeed = Client.shared.flatFeed(feedSlug: "user")

// List followers.
userFeed?.followers(offset: 10, limit: 10) { result in /* ... */ }

await user1.followers(limit: 10, offset: 10);

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

Parameters

Response Data

{
  "results": [
    {
      "feed_id": "conversation2:test",
      "target_id": "conversation2:user_2",
      "created_at": "2018-01-19T09:35:17.817332Z"
    }
  ],
  "duration": "1.92ms"
}

Reading Followed Feeds

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

// Retrieve last 10 feeds followed by userFeed1
await userFeed1.FollowingAsync(0, 10);

// Retrieve 10 feeds followed by userFeed1 starting from the 11th
await userFeed1.FollowingAsync(10, 10);

// Check if user1 follows specific feeds
await userFeed1.FollowingAsync(0, 2, new[] { "user:42", "user:43" })

// Retrieve last 10 feeds followed by user_feed_1
let response = await user1.following({ offset: 0, limit: 10 });

// Retrieve 10 feeds followed by user_feed_1 starting from the 11th
response = await user1.following({ offset: 10, limit: 10 });

// Check if user1 follows specific feeds
response = await user1.following({
  offset: 0,
  limit: 2,
  filter: ["user:42", "user:43"],
});

# Retrieve last 10 feeds followed by user_feed_1
user_feed_1.following(offset=0, limit=10)

# Retrieve 10 feeds followed by user_feed_1 starting from the 11th
user_feed_1.following(offset=10, limit=10)

# Check if user_feed_1 follows specific feeds
user_feed_1.following(offset=0, limit=2, feeds=['user:42', 'user:43'])

# Retrieve 10 feeds followed by user_feed_1
user_feed_1.following(0, 10)

# Retrieve 10 feeds followed by user_feed_1 starting from the 11th
user_feed_1.following(10, 10)

# Check if user_feed_1 follows specific feeds
user_feed_1.following(0, 2, filter=['user:42', 'user:43'])

// Retrieve 10 feeds followed by $userFeed1
$userFeed1->following(0, 10);

// Retrieve 10 feeds followed by $userFeed1 starting from the 10th (2nd page)
$userFeed1->following(10, 10);

// Check if $userFeed1 follows specific feeds
$userFeed1->following(0, 2, ['user:42', 'user:43']);

// Retrieve last 10 feeds followed by user_feed_1
List<followrelation> followed = userFeed.getFollowed(new Limit(10), new Offset(0)).get();

// Retrieve 10 feeds followed by user_feed_1 starting from the 11th
followed = userFeed.getFollowed(new Limit(10), new Offset(10)).get();

// Check if user_feed_1 follows specific feeds
followed = userFeed.getFollowed(new Limit(2), new Offset(0), new FeedID("user:42"), new FeedID("user", "43")).get();</followrelation>

// Retrieve last 10 feeds followed by user_42
	resp, err := userFeed.GetFollowing(
		context.TODO(),
		stream.WithFollowingOffset(0),
		stream.WithFollowingLimit(10),
	)
	if err != nil {
		panic(err)
	}
	for _, r := range resp.Results {
		fmt.Println(r)
		//...
	}

	// Retrieve 10 feeds followed by user_42 starting from the 11th
	resp, err = userFeed.GetFollowing(
		context.TODO(),
		stream.WithFollowingOffset(10),
		stream.WithFollowingLimit(10),
	)
	if err != nil {
		panic(err)
	}

	// Check if user_42 follows specific feeds
	resp, err = userFeed.GetFollowing(
		context.TODO(),
		stream.WithFollowingOffset(0),
		stream.WithFollowingLimit(2),
		stream.WithFollowingFilter("user:user_43", "user:user_44"),
	)
	if err != nil {
		panic(err)
	}

// Retrieve last 10 feeds followed by the current user.
userFeed?.following(limit: 10) { result in /* ... */ }

// Retrieve 10 feeds followed by the current user starting from the 11th.
userFeed?.following(offset: 10, limit: 10) { result in /* ... */ }

// Check if the current user follows specific feeds.
userFeed?.following(filter: [FeedId(feedSlug: "user", userId: "42"),
               FeedId(feedSlug: "user", userId: "43")], limit: 2) { result in /* ... */ }

// Retrieve last 10 feeds followed by user1
await user1.following(offset: 0, limit: 10);

// Retrieve 10 feeds followed by user1 starting from the 11th
await user1.following(offset: 10, limit: 10);

// Check if user1 follows specific feeds
await user1.following(
  offset: 0,
 limit: 2,
 filter: [FeedId.id('user:42'), FeedId.id('user:43')]);

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

Parameters

Response Data

{
  "results": [
    {
      "feed_id": "conversation2:test",
      "target_id": "conversation2:user_2",
      "created_at": "2018-01-19T09:35:17.817332Z",
      "updated_at": null
    }
  ],
  "duration": "1.92ms"
}

Reading follow stats

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.

// get follower and following stats of the feed
client.feed("user", "me").followStats();

// get follower and following stats of the feed but also filter with given slugs
// count by how many timelines follow me
// count by how many markets are followed
client.feed.followStats({
  followerSlugs: ["timeline"],
  followingSlugs: ["market"],
});

// get follower and following stats of the feed
await client.flatFeed('user', 'me').followStats();

// get follower and following stats of the feed but also filter with given slugs
// count by how many timelines follow me
// count by how many markets are followed
await client
 .flatFeed('user', 'me')
 .followStats(followerSlugs: ['timeline'], followingSlugs: ['market']);

# get follower and following stats of the feed but also filter with given slugs
# count by how many timelines follow me
# count by how many markets are followed
response = client.follow_stats(feed_id, follower_slugs=["timeline"], following_slugs=["market"])

# get follower and following stats of the feed but also filter with given slugs
# count by how many timelines follow me
# count by how many markets are followed
timeline_feed_1 = client.feed('user', 'me')
stats = timeline_feed_1.follow_stats(followers_slugs = ['user'], following_slugs = ['user'])

Response Data

{
  "results": {
    "followers": { "count": 1529, "feed": "user:me" },
    "following": { "count": 81, "feed": "user:me" }
  },
  "duration": "1.92ms"
}