let query = FeedsQuery(
filter: .equal(.createdById, "john"),
sort: [Sort(field: .createdAt, direction: .reverse)],
limit: 10,
watch: true
)
let feedList = client.feedList(for: query)
// Page 1
let page1 = try await feedList.get()
// Page 2
let page2 = try await feedList.queryMoreFeeds(limit: 10)
let page1And2 = feedList.state.feedsSearch for Feeds
The query feeds endpoint lets you search for feeds.
Examples
Querying My Feeds
val query = FeedsQuery(
filter = FeedsFilterField.createdById.equal("john"),
sort = listOf(FeedsSort(FeedsSortField.CreatedAt, SortDirection.REVERSE)),
limit = 10,
watch = true
)
val feedList = client.feedList(query = query)
// Page 1
val page1: Result<List<FeedData>> = feedList.get()
// Page 2
val page2: Result<List<FeedData>> = feedList.queryMoreFeeds(limit = 10)
val page1And2 = feedList.state.feedsQuerying Feeds Where I Am a Member
val query = FeedsQuery(
filter = FeedsFilterField.members.contains("john")
)
val feedList = client.feedList(query = query)
val feeds: Result<List<FeedData>> = feedList.get()Querying feeds by name or description
val sportsQuery = FeedsQuery(
filter = Filters.and(
FeedsFilterField.visibility.equal("public"),
FeedsFilterField.name.query("Sports")
)
)
val sportsFeedList = client.feedList(query = sportsQuery)
val sportsFeeds: Result<List<FeedData>> = sportsFeedList.get()
val techQuery = FeedsQuery(
filter = Filters.and(
FeedsFilterField.visibility.equal("public"),
FeedsFilterField.description.query("tech")
)
)
val techFeedList = client.feedList(query = techQuery)
val techFeeds: Result<List<FeedData>> = techFeedList.get()Querying feeds by creator name
val query = FeedsQuery(
filter = Filters.and(
FeedsFilterField.visibility.equal("public"),
FeedsFilterField.createdByName.query("Thompson"),
)
)
val feedList = client.feedList(query = query)
val feeds: Result<List<FeedData>> = feedList.get()A complex example
Search for user feeds where text matches the feed's name, description or creator's name:
val query = FeedsQuery(
filter = Filters.and(
FeedsFilterField.groupId.equal("user"),
Filters.or(
FeedsFilterField.name.query(searchQuery),
FeedsFilterField.description.query(searchQuery),
FeedsFilterField.createdByName.query(searchQuery)
)
)
)
val feedList = client.feedList(query = query)
val feeds: Result<List<FeedData>> = feedList.get()Feeds Queryable Built-in Fields
| name | type | description | supported operations | example |
|---|---|---|---|---|
id | string or list of strings | The ID of the feed | $in, $eq | { id: { $in: [ 'abc', 'xyz' ] } } |
group_id | string or list of strings | The ID of the group this feed belongs to | $in, $eq | { group_id: { $in: [ 'abc', 'xyz' ] } } |
feed | string or list of strings | The fully qualified feed ID (group_id:id) | $in, $eq | { fid: { $in: [ 'abc', 'xyz' ] } } |
visibility | string or list of strings | The visibility setting of the feed | $in, $eq | { visibility: { $eq: 'public' } } |
created_by_id | string or list of strings | The ID of the user who created the feed | $in, $eq | { created_by_id: { $in: [ 'abc', 'xyz' ] } } |
created_by.name | string | The name of the user who created the feed | $eq, $q, $autocomplete | { 'created_by.name': { $autocomplete: 'Frank' } } |
name | string | The name of the feed | $eq, $q, $autocomplete | { name: { $q: 'Sports' } } |
description | string | The description of the feed | $eq, $q, $autocomplete | { description: { $autocomplete: 'tech' } } |
member_count | number | The number of members in this feed | $eq, $ne, $gt, $lt, $gte, $lte | { member_count: { $gt: 100 } } |
members | list of strings | The list of members in this feed | $in | { members: { $in: [ 'bob', 'alice' ] } } |
following_count | number | The number of feeds this feed follows | $eq, $ne, $gt, $lt, $gte, $lte | { following_count: { $gt: 100 } } |
following_feeds | list of strings | The list of feeds this feed follows | $in | { following_feeds: { $in: [ 'feed1', 'feed2' ] } } |
follower_count | number | The number of followers of this feed | $eq, $ne, $gt, $lt, $gte, $lte | { follower_count: { $gt: 100 } } |
created_at | string, RFC3339 timestamp | The time the feed was created | $eq, $gt, $lt, $gte, $lte | { created_at: { $gte: '2023-12-04T09:30:20.45Z' } } |
updated_at | string, RFC3339 timestamp | The time the feed was updated | $eq, $gt, $lt, $gte, $lte | { updated_at: { $gte: '2023-12-04T09:30:20.45Z' } } |
filter_tags | list of strings | Tags for filtering the feed | $eq, $contains, $in | { filter_tags: { $in: [ 'sports', 'news' ] } } |
near | object | GEO point and distance (km) to filter by | $eq | { near: { $eq: { lat: 40.0, lng: -74.0, distance: 200 } } } |
within_bounds | object | GEO bounding box to filter by | $eq | { within_bounds: { $eq: { ne_lat: 40.0, ne_lng: -115.0, sw_lat: 32.0, sw_lng: -125.0 } } } |
Filter expressions can be combined using $or and $and operators as well.
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.