GET v0.1/feed/{id}

Get Feed with Items

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The Id of the Feed

integer

Required

Count

The number of items to include in the response. Default is 20. Max is 100

integer

None.

CreatedBefore

Only return items that are created before this date. Defaults to newest items. Cannot be used in combination with PinnedStatus.Any

date

None.

PinnedStatus

Only include items that are either pinned or not pinned. Defaults to not pinned. PinnedStatus will default to "NotPinned" if CreatedBefore is set.

PinnedStatus

None.

ItemStatus

Only include items that have this status. Defaults to Approved

ItemStatus

None.

SourceTypes

Only include items that are of these source types. Defaults to include items from all source types

Collection of SourceType

None.

Body Parameters

None.

Response Information

Resource Description

Feed
NameDescriptionTypeAdditional information
Id

The Feed id

integer

None.

Name

The Feed Name

string

None.

LastUpdate

The update time of the last updated Source.

date

None.

Items

A subset of Items for this Feed. Default is 20 latest

Collection of Item

None.

MoreItems

A value indicating if there are more items to page through

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 123,
  "name": "My Feed",
  "lastUpdate": "2019-03-23T05:54:33.6617818Z",
  "items": [
    {
      "id": 12345,
      "originalIdentifier": "axfdsd334",
      "createdTime": "2019-03-23T05:54:33.6774073Z",
      "mediaUrl": "http://urltomedia.com",
      "videoUrl": null,
      "text": "This is a text",
      "title": "This is a title",
      "url": "http://urltoitem.com",
      "userId": "abc123",
      "userProfilePictureUrl": "http://urltoprofilepicture.com",
      "userRealName": "Joe Toe",
      "username": "joethetoe",
      "highLighted": false,
      "pinned": false,
      "status": "Approved",
      "sourceId": 1,
      "sourceType": "InstagramHashtag",
      "callToActionUrl": "http://linktoclick.com",
      "callToActionText": "Click Me"
    }
  ],
  "moreItems": false
}