Activity Feeds v3 is in beta — try it out!

Feeds

Creating a Feed

require 'getstream_ruby'

# Feed with no extra fields, of feed group "user"
feed = client.feed('user', 'john')
request = GetStream::Generated::Models::GetOrCreateFeedRequest.new(user_id: 'john')
feed_response = feed.get_or_create_feed(request)

# More options with custom data
feed2 = client.feed('user', 'jack')
request2 = GetStream::Generated::Models::GetOrCreateFeedRequest.new(
  user_id: 'jack',
  data: GetStream::Generated::Models::FeedInput.new(
    description: 'My personal feed',
    name: 'jack',
    visibility: 'public'
  )
)
feed_response2 = feed2.get_or_create_feed(request2)

Built-in feed groups

GroupDescription
userA feed setup for the content a user creates. Typically you add activities here when someone writes a post
timelineThe timeline feed is used when you’re following. So if user Charlie is following John, timeline:charlie would follow user:john
foryouA version of the timeline feed that adds popular content, and priorities popularity over recency
notificationA notification feed. Think of the bell icon you see in most apps
storyA feed set up for users to post story activities (activities with expiration data)
storiesA timeline feed which can be used to follow other users’ stories.

Reading a Feed

Here is a basic example of how to read a feed:

require 'getstream_ruby'

# Reading a feed
feed = client.feed('user', 'john')
request = GetStream::Generated::Models::GetOrCreateFeedRequest.new(user_id: 'john')
feed_response = feed.get_or_create_feed(request)

# Access feed data
feed_data = feed_response.feed
activities = feed_response.activities
members = feed_response.members

The response will contain the following data.

You have more options when reading a feed, let’s go over a few:

require 'getstream_ruby'

# Reading multiple feeds
feed1 = client.feed('user', 'john')
request1 = GetStream::Generated::Models::GetOrCreateFeedRequest.new(user_id: 'john')
feed_response_1 = feed1.get_or_create_feed(request1)

feed2 = client.feed('user', 'jane')
request2 = GetStream::Generated::Models::GetOrCreateFeedRequest.new(user_id: 'jane')
feed_response_2 = feed2.get_or_create_feed(request2)

Feed Pagination

Here is how you can read the next page on the feed:

let feed = client.feed(
    for: .init(
        group: "user",
        id: "john",
        activityLimit: 10
    )
)
// Page 1
try await feed.getOrCreate()
let activities = feed.state.activities // First 10 activities

// Page 2
let page2Activities = try await feed.queryMoreActivities(limit: 10)

let page1And2Activities = feed.state.activities

Filtering Examples

filter provides a performant way to read a feed, and only select activities that match a given filter.

Please note that for search feature you should use query activities endpoint

# Add a few activities
client.feeds.upsert_activities(
  GetStream::Generated::Models::UpsertActivitiesRequest.new(
    activities: [
      {
        "feeds" => ["user:123"],
        "type" => "post",
        "text" => "first",
        "filter_tags" => ["green", "blue"],
        "user_id" => "123"
      },
      {
        "feeds" => ["user:123"],
        "type" => "post",
        "text" => "second",
        "filter_tags" => ["yellow", "blue"],
        "user_id" => "123"
      },
      {
        "feeds" => ["user:123"],
        "type" => "post",
        "text" => "third",
        "filter_tags" => ["orange"],
        "user_id" => "123"
      }
    ]
  )
)

# Now read the feed, this will fetch activity 1 and 2
response = client.feeds.get_or_create_feed(
  "user",
  "123",
  GetStream::Generated::Models::GetOrCreateFeedRequest.new(
    filter: { "filter_tags" => ["blue"] },
    user_id: "123"
  )
)

The filter syntax also supports $or and $and, so here’s an example that’s a little more complicated:

# Get all the activities where filter tags contain both "green" and "orange"
response = client.feeds.get_or_create_feed(
  "user",
  "john",
  GetStream::Generated::Models::GetOrCreateFeedRequest.new(
    filter: {
      "$and" => [
        { "filter_tags" => ["green"] },
        { "filter_tags" => ["orange"] }
      ]
    },
    user_id: "john"
  )
)

Filters

What filters you can use when reading a feed depends on the feed group (or view, if provided) configuration.

The activity selectors page explains this in detail, but some quick examples: the user group uses current selector, and the timeline group the following selector by default.

The following filter options are available for the following selector:

nametypedescriptionsupported operationsexample
idstring or list of stringsThe ID of the activity$in, $eq{ id: { $in: [ 'abc', 'xyz' ] } }
filter_tagslist of stringsTags for filtering$eq, $contains{ filter_tags: { $in: [ 'categoryA', 'categoryB' ] } }

The following filter options are available for the current, popular, interest, proximity and query selectors:

nametypedescriptionsupported operationsexample
idstring or list of stringsThe ID of the activity$in, $eq{ id: { $in: [ 'abc', 'xyz' ] } }
activity_typestring or list of stringsThe type of the activity$in, $eq{ activity_type: { $in: [ 'abc', 'xyz' ] } }
user_idstring or list of stringsThe ID of the user who created the activity$in, $eq{ user_id: { $in: [ 'abc', 'xyz' ] } }
textstringThe text content of the activity$eq, $q, $autocomplete{ text: { $q: 'popularity' } }
search_dataobjectThe extra metadata for search indexing$contains, $path_exists{ search_data: { $contains: { 'category': 'sports', 'status': 'active' } } }
interest_tagslist of stringsTags for user interests$eq, $contains{ interest_tags: { $in: [ 'sports', 'music' ] } }
filter_tagslist of stringsTags for filtering$eq, $contains{ filter_tags: { $in: [ 'categoryA', 'categoryB' ] } }
created_atstring, must be formatted as an RFC3339 timestampThe time the activity was created$eq, $gt, $lt, $gte, $lte{ created_at: { $gte: '2023-12-04T09:30:20.45Z' } }
popularitynumberThe popularity score of the activity$eq, $ne, $gt, $lt, $gte, $lte{ popularity: { $gte: 70 } }
nearobjectIndicates the GEO point to search nearby activities.$eq{ near: { $eq: { lat: 40.0, lng: -74.0, distance: 200 } } }
within_boundsobjectIndicates the GEO bounds to search for activities within.$eq{ within_bounds: { $eq: { ne_lat: 40.0, ne_lng: -115.0, sw_lat: 32.0, sw_lng: -125.0 } } }

The filter syntax also supports $or and $and:

# Get all the activities where filter tags contain both "green" and "orange"
filter = {
  "$and" => [
    { "filter_tags" => ["green"] },
    { "filter_tags" => ["orange"] }
  ]
}

When providing filter to read a feed, activity selector filters on group/view level are ignored.

Feed Members

You can add and remove members to a feed. This is useful for building communities where a set of users can add content to the feed.

It’s not possible to set/update member role on client-side. Use server-side SDKs for this. When adding members client-side all new members will have feed_member role:

# The following methods are available to edit the members of a feed
client.feeds.update_feed_members(
  "user",
  "community_id",
  GetStream::Generated::Models::UpdateFeedMembersRequest.new(
    operation: "upsert",
    members: [
      GetStream::Generated::Models::FeedMemberRequest.new(
        user_id: "john",
        role: "moderator",
        custom: { "joined" => "2024-01-01" }
      )
    ]
  )
)

# Remove members
client.feeds.update_feed_members(
  "user",
  "community_id",
  GetStream::Generated::Models::UpdateFeedMembersRequest.new(
    operation: "remove",
    members: [
      GetStream::Generated::Models::FeedMemberRequest.new(user_id: "john"),
      GetStream::Generated::Models::FeedMemberRequest.new(user_id: "jane")
    ]
  )
)

# Set members (overwrites the list)
client.feeds.update_feed_members(
  "user",
  "community_id",
  GetStream::Generated::Models::UpdateFeedMembersRequest.new(
    operation: "set",
    members: [
      GetStream::Generated::Models::FeedMemberRequest.new(
        user_id: "john",
        role: "moderator"
      )
    ]
  )
)

Feed members vs followers

Followers and members might seem like similar concepts, but they serve two different purposes with some key differences.

Followers can only be feeds (for example the timeline feed of Alice follows the user feed of Bob). Followers’ aim is to access the content of a feed they’re interested in and interact with it.

Members can only be users (for example Alice adds Bob as a member to her feed about “Travel Hacks”). The aim of feed members is usually to help out with admin tasks (helpful if you want to build apps similar to Facebook pages) or to decide what activities a user has access to using membership levels (for example Bob becomes a premium member in Alice’s community).

Member invites

You can invite members with the invite flag, where invited users can accept or reject the membership.

# Invite a member
client.feeds.update_feed_members(
  "user",
  "alice",
  GetStream::Generated::Models::UpdateFeedMembersRequest.new(
    operation: "upsert",
    members: [
      GetStream::Generated::Models::FeedMemberRequest.new(
        user_id: "john",
        role: "moderator",
        invite: true,
        custom: { "reason" => "community builder" }
      )
    ]
  )
)

# Accept feed member invite
client.feeds.accept_feed_member_invite(
  "user",
  "alice",
  GetStream::Generated::Models::AcceptFeedMemberInviteRequest.new(user_id: "john")
)

# Reject feed member invite
client.feeds.reject_feed_member_invite(
  "user",
  "alice",
  GetStream::Generated::Models::RejectFeedMemberInviteRequest.new(user_id: "john")
)

Query Feeds

Querying feeds allows you to do things like showing the list of communities you’ve joined.

Here’s an example of how to query feeds:

Querying My Feeds

# First page query
first_page = client.feeds.query_feeds(
  GetStream::Generated::Models::QueryFeedsRequest.new(
    filter: { "created_by_id" => "john" },
    limit: 10,
    sort: [{ "field" => "created_at", "direction" => -1 }]
  )
)

# Second page using next cursor from first page
second_page = client.feeds.query_feeds(
  GetStream::Generated::Models::QueryFeedsRequest.new(
    filter: { "created_by_id" => "john" },
    limit: 10,
    sort: [{ "field" => "created_at", "direction" => -1 }],
    _next: first_page.data._next
  )
)

Querying Feeds Where I Am a Member

response = client.feeds.query_feeds(
  GetStream::Generated::Models::QueryFeedsRequest.new(
    filter: {
      "members" => { "$in" => ["john"] }
    }
  )
)

Querying feeds by name or visibility

# Search public feeds by name
response1 = client.feeds.query_feeds(
  GetStream::Generated::Models::QueryFeedsRequest.new(
    filter: {
      "visibility" => { "$eq" => "public" },
      "name" => { "$q" => "Sports" }
    }
  )
)

# Search public feeds by description
response2 = client.feeds.query_feeds(
  GetStream::Generated::Models::QueryFeedsRequest.new(
    filter: {
      "visibility" => "public",
      "description" => { "$autocomplete" => "tech" }
    }
  )
)

Querying feeds by creator name

response = client.feeds.query_feeds(
  GetStream::Generated::Models::QueryFeedsRequest.new(
    filter: {
      "visibility" => "public",
      "created_by.name" => { "$q" => "Thompson" }
    }
  )
)

Feeds Queryable Built-in Fields

nametypedescriptionsupported operationsexample
idstring or list of stringsThe ID of the feed$in, $eq{ id: { $in: [ 'abc', 'xyz' ] } }
group_idstring or list of stringsThe ID of the group this feed belongs to$in, $eq{ group_id: { $in: [ 'abc', 'xyz' ] } }
feedstring or list of stringsThe fully qualified feed ID (group_id:id)$in, $eq{ fid: { $in: [ 'abc', 'xyz' ] } }
visibilitystring or list of stringsThe visibility setting of the feed$in, $eq{ visibility: { $eq: 'public' } }
created_by_idstring or list of stringsThe ID of the user who created the feed$in, $eq{ created_by_id: { $in: [ 'abc', 'xyz' ] } }
created_by.namestringThe name of the user who created the feed$eq, $q, $autocomplete{ 'created_by.name': { $autocomplete: 'Frank' } }
namestringThe name of the feed$eq, $q, $autocomplete{ name: { $q: 'Sports' } }
descriptionstringThe description of the feed$eq, $q, $autocomplete{ description: { $autocomplete: 'tech' } }
member_countnumberThe number of members in this feed$eq, $ne, $gt, $lt, $gte, $lte{ member_count: { $gt: 100 } }
memberslist of stringsThe list of members in this feed$in{ members: { $in: [ 'bob', 'alice' ] } }
following_countnumberThe number of feeds this feed follows$eq, $ne, $gt, $lt, $gte, $lte{ following_count: { $gt: 100 } }
following_feedslist of stringsThe list of feeds this feed follows$in{ following_feeds: { $in: [ 'feed1', 'feed2' ] } }
follower_countnumberThe number of followers of this feed$eq, $ne, $gt, $lt, $gte, $lte{ follower_count: { $gt: 100 } }
created_atstring, RFC3339 timestampThe time the feed was created$eq, $gt, $lt, $gte, $lte{ created_at: { $gte: '2023-12-04T09:30:20.45Z' } }
updated_atstring, RFC3339 timestampThe time the feed was updated$eq, $gt, $lt, $gte, $lte{ updated_at: { $gte: '2023-12-04T09:30:20.45Z' } }
filter_tagslist of stringsTags for filtering the feed$eq, $contains, $in{ filter_tags: { $in: [ 'sports', 'news' ] } }

Feeds can be sorted by created_at, updated_at, member_count, follower_count, and following_count.

Be sure to reach out to support if you need additional query feed capabilities.

Query Feed Members

You can query the members of a feed. This is useful for showing the list of members in a community.

val memberList = client.memberList(
    MembersQuery(
        fid = FeedId(group = "stock", id = "apple"),
        filter = MembersFilterField.role.equal("moderator"),
    )
)
memberList.get()
memberList.state.members.collect { members ->
    // Handle members
}

Feed Members Queryable Built-in Fields

nametypedescriptionsupported operationsexample
user_idstring or list of stringsThe ID of the user who is a member of the feed$in, $eq{ user_id: { $eq: 'user_123' } }
rolestring or list of stringsThe role of the member$in, $eq{ role: { $in: [ 'admin', 'moderator', 'member' ] } }
statusstring or list of stringsThe membership status$in, $eq{ status: { $in: [ 'member', 'pending', 'rejected' ] } }
created_atstring, must be formatted as an RFC3339 timestampThe time the membership was created$eq, $gt, $gte, $lt, $lte{ created_at: { $gte: '2023-12-04T09:30:20.45Z' } }
updated_atstring, must be formatted as an RFC3339 timestampThe time the membership was last updated$eq, $gt, $gte, $lt, $lte{ updated_at: { $gte: '2023-12-04T09:30:20.45Z' } }
© Getstream.io, Inc. All Rights Reserved.