Skip to content

Feeds

The Feeds API provides access to lists of content similar to how a user sees them in the Firstup experience application. Feeds are specific to the authenticated user and a user can only see what the platform gives them access to.

At their core, feeds are built using filters to find the exact topics and type of posts your application wishes to expose to its users. One of the basic filters is the channels.id filter, but there are additional filters like content_type and visibility. There are also preset configurations called named feeds, which uses the name query parameter and are convenient wrappers around a set of filters. These include things like "trending" posts, "following", and "myfeed".
The full list of feed names is outlined in the listFeedPosts documentation.

Feeds are paginated, but have no total records as they are an inherently dynamic list of posts.

Actions like liking, bookmarking, and responding to polls can be taken on individual posts in the same way they can be taken on the experience applications.


The Feeds API requires authentication as a user.



Resources

Operations

Return a user's feed of posts

Request

Provides a list of posts in the user’s feed. Accepts pagination and filtering parameters. Upon enabling expanded reactions types, the response will include the additional reaction types.
Resources

Security
oauth2_as_a_user(Required scopes: feeds.read)
Query
namestring

Use a specific named feed, which is a preset of filters for specific types of feeds. By default, requests return the "myfeed" feed, which includes posts the user can see but may not necessarily be following. Specifying a name not listed here will result in a 400 Bad Request error.

Default:"myfeed"
Enum:"myfeed""following""resources""trending""icymi""featured""bookmarked""community_images""for_you"
searchstring

Find content matching provided keywords. When specified, parameters other than pagination and the topics filter will be ignored.

filter.user_behaviorsArray of strings

Return content posts that users have interacted with in the provided ways. Defaults to all content if left empty.

Items Enum:"liked""bookmarked""read""unread"
filter.channels.idArray of integers

Build the feed from the given topics. Provide a list as either array or comma separated list. Returns posts that are published to ANY of the topics. Defaults to all topics.

filter.initiative_tags.idArray of integers

Build the feed from the given initiative tags. Provide a list as either array or comma separated list. Returns posts that are published with ANY of the initiative tags. Defaults to all content.

filter.content_typeArray of strings

Return only content matching the provided types, which can be a single type or a list as either array or comma separated list. Possible values include 'article', 'link', 'note', 'image', and 'video'. Defaults to all types. Including a type not listed her will result in a 400 Bad Request error.

Items Enum:"article""link""note""image""video"
filter.visibilitystring

Limit records to the value provided.

Default:"any"
Enum:"public""private""any"
filter.featuredstring

Limit records to the value provided.

Default:"any"
Enum:"true""false""any"
page.sizeinteger, (int64)

Return page.size number of records starting at size*number. The default page size is 10 (number of records per page), resulting in the first page being retrieved. The maximum page size is 100.

page.numberinteger, (int64)

Using classical pagination, the page number to return. Default is 1

Bodyapplication/json
Array of integers
curl -i -X GET \
  'https://partner.socialchorus.com/v2/feed/posts?name=myfeed&search=string&filter.user_behaviors=liked&filter.channels.id=0&filter.initiative_tags.id=0&filter.content_type=article&filter.visibility=public&filter.featured=true&page.size=0&page.number=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    0
  ]'

Responses

Success

Bodyapplication/json
dataArray of objects(Reactions.Fields)required
metaobject
Response
{
  "data": [
    { … }
  ],
  "meta": {
    "filters": { … },
    "feed_name": "myfeed",
    "pagination": { … }
  }
}