POST api/v2.0/DataFeed/GetData
This returns a feed of content published on the site based on the request parameters provided. This endpoint provides content/items in a generic pattern, so that users can display the items in the response as a feed of information pulling from the website. The feed can provide you with several different types of content, which you can filter down to using the request to fit your needs. This endpoint is relatively complex in terms of its capabilities in the request and response.
Request Information
URI Parameters
None.
Body Parameters
The request object can be used to search, sort, and filter your feed based on your needs.
DataFeedRequestName | Description | Type | Additional information |
---|---|---|---|
SearchTerm |
The search term string provided will be used to filter feed items down based on relation to the term. Similar to using the search functionality on our website. |
string |
None. |
Filter |
Properties provided as a part of this object will further filter down the data feed items returned |
DataFeedFilter |
None. |
SortBy |
Identifies how results are sorted Values : date, score or title Default: date |
string |
None. |
SortOrder |
Sort Order Values : asc or desc Default: asc when SortBy is title desc when SortBy is date or score |
string |
None. |
NumberToReturn |
Number of items to return in the feed. Valid number to return is between 0 and 25. Default is 10. |
integer |
None. |
Direction |
Direction to fetch from the specified marker up (Larger Value) down (Smaller Value) |
string |
None. |
Marker |
Origin marker that can be used to grab the next set of feed items based on a marker from a previous request. |
string |
None. |
Request Formats
application/json, text/json
{ "SearchTerm": "sample string 1", "Filter": { "MyCommunitiesOnly": true, "CommunityKeys": [ "e591d19b-5afe-402c-b443-0d258a701f0f", "eb8aa5af-6cac-45a4-b4fd-44ce4ff76b1d" ], "ItemTypes": [ "sample string 1", "sample string 2" ], "ExcludeAttachments": true, "ExcludeBulkUploaded": true, "UserTags": [ "sample string 1", "sample string 2" ], "AdminTags": [ "sample string 1", "sample string 2" ], "AtMentions": [ "bbc39be7-49bd-4ea5-a236-66f7b45b22c6", "c6fe51bb-f33e-4170-9251-603b12ce3a6f" ], "LibraryKey": "9bf39c30-7d72-4b45-a78a-6b6fcac4d2bb" }, "SortBy": "sample string 2", "SortOrder": "sample string 3", "NumberToReturn": 4, "Direction": "sample string 5", "Marker": "sample string 6" }
application/xml, text/xml
<DataFeedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.DataFeed"> <Direction>sample string 5</Direction> <Marker>sample string 6</Marker> <NumberToReturn>4</NumberToReturn> <Filter> <AdminTags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </AdminTags> <AtMentions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>bbc39be7-49bd-4ea5-a236-66f7b45b22c6</d3p1:guid> <d3p1:guid>c6fe51bb-f33e-4170-9251-603b12ce3a6f</d3p1:guid> </AtMentions> <CommunityKeys xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>e591d19b-5afe-402c-b443-0d258a701f0f</d3p1:guid> <d3p1:guid>eb8aa5af-6cac-45a4-b4fd-44ce4ff76b1d</d3p1:guid> </CommunityKeys> <ExcludeAttachments>true</ExcludeAttachments> <ExcludeBulkUploaded>true</ExcludeBulkUploaded> <ItemTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </ItemTypes> <LibraryKey>9bf39c30-7d72-4b45-a78a-6b6fcac4d2bb</LibraryKey> <MyCommunitiesOnly>true</MyCommunitiesOnly> <UserTags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </UserTags> </Filter> <SearchTerm>sample string 1</SearchTerm> <SortBy>sample string 2</SortBy> <SortOrder>sample string 3</SortOrder> </DataFeedRequest>
Response Information
Resource Description
This returns feed items based off of the search, sort, and filters provided to it. These feed items are returned in a generic format. This means that not all of the properties will be provided for each feed item type. For example an announcement feed item may return less information than a Blog feed item.
Collection of DataFeedItemName | Description | Type | Additional information |
---|---|---|---|
ItemKey |
The primary key associated with the item based on its content type |
globally unique identifier |
None. |
Title |
Title |
string |
None. |
Body |
Description |
string |
None. |
Contributor |
Author or Contributor of the data feed item |
DataFeedContributor |
None. |
ParentContainer |
Parent in which the data feed item is contained. Ex: Community |
DataFeedParentContainer |
None. |
ActionText |
Action Taken Text |
string |
None. |
CreateDate |
UTC timestamp for when the item was created. Use only if PublishedDate is not available. |
date |
None. |
PublishedDate |
UTC timestamp for when the item was published to users on the site |
date |
None. |
PublicationStatus |
Item status determined by PublishedOn date - the possible statuses include "scheduled", "draft", and "published" |
string |
None. |
Date01 |
Custom date field used for certain content types such as the start date for events. As well as best response date for questions and answers. |
date |
None. |
Date02 |
Custom date field used for certain content types such as the end date for events |
date |
None. |
HasRecommended |
Whether or not the current user has liked/recommended the feed item |
boolean |
None. |
HasReplied |
Whether or not the current user has replied/commented on the feed item |
boolean |
None. |
Bool01 |
Generic boolean value specific to the type, ex: Whether or not the current user has registered for the item/event. |
boolean |
None. |
Bool02 |
Generic boolean value specific to the type, ex: Whether or not the item/event is open for registration. |
boolean |
None. |
ItemType |
The type of content, such as blog, announcement, ... |
string |
None. |
LinkToViewItem |
Provides a url to view the item on the website |
string |
None. |
Tags |
All of the tags indexed for the item. This includes user tags and admin based tags |
Collection of ItemTagResponse |
None. |
RecommendationCount |
The number of times the item has been "recommended" or "liked" |
integer |
None. |
AttachmentsContainer |
The attachment container info, the attachments within the container, and their necessary metadata related to the specified item |
DataFeedAttachmentsContainer |
None. |
ResponseCount |
The number of responses for the thread that the item is contained in. If it is not contained within a thread it should not return. |
integer |
None. |
Text01 |
Custom text field used for certain content types such as the location for events |
string |
None. |
Text02 |
Custom text field used for certain content types such as the start/end date string for events |
string |
None. |
Text03 |
Custom text field used for certain content types such as the event type name for events |
string |
None. |
Text04 |
Custom text field used for certain content types such as the registration type for events |
string |
None. |
FeaturedImageUrl |
Returns a link to an image/icon to display for the data feed item |
string |
None. |
ThreadKey |
The ID of the thread containing the item |
globally unique identifier |
None. |
Marker |
Item origin marker |
string |
None. |
Response Formats
application/json, text/json
[ { "ItemKey": "ea749b4b-142b-4ed4-86fc-ebee52a7a291", "Title": "sample string 2", "Body": "sample string 3", "Contributor": { "ContactKey": "7ba3598b-40ff-428c-854e-71b830a4a15e", "PictureUrl": "sample string 2", "FirstName": "sample string 3", "LastName": "sample string 4", "DisplayName": "sample string 5", "ViewUrl": "sample string 6" }, "ParentContainer": { "ContainerKey": "3a48c617-29dc-4682-abdc-3ec19cb6423b", "ContainerName": "sample string 2", "ContainerType": "sample string 3" }, "ActionText": "sample string 4", "CreateDate": "2024-12-14T14:24:41.659058Z", "PublishedDate": "2024-12-14T14:24:41.659058Z", "PublicationStatus": "published", "Date01": "2024-12-14T14:24:41.659058Z", "Date02": "2024-12-14T14:24:41.659058Z", "HasRecommended": true, "HasReplied": true, "Bool01": true, "Bool02": true, "ItemType": "sample string 13", "LinkToViewItem": "sample string 14", "Tags": [ { "Tag": "sample string 1", "TagType": "sample string 2" }, { "Tag": "sample string 1", "TagType": "sample string 2" } ], "RecommendationCount": 15, "AttachmentsContainer": { "DocumentKey": "3c634124-5838-49bb-96d5-caaa0c626391", "Attachments": [ { "AttachmentKey": "0c207e27-d1e9-498c-83db-244ca140cc9d", "AttachmentName": "sample string 2", "AttachmentUrl": "sample string 3", "MimeType": "sample string 4" }, { "AttachmentKey": "0c207e27-d1e9-498c-83db-244ca140cc9d", "AttachmentName": "sample string 2", "AttachmentUrl": "sample string 3", "MimeType": "sample string 4" } ] }, "ResponseCount": 16, "Text01": "sample string 17", "Text02": "sample string 18", "Text03": "sample string 19", "Text04": "sample string 20", "FeaturedImageUrl": "sample string 21", "ThreadKey": "3feda3cf-497e-4678-a0f7-14a9ac918147", "Marker": "sample string 23" }, { "ItemKey": "ea749b4b-142b-4ed4-86fc-ebee52a7a291", "Title": "sample string 2", "Body": "sample string 3", "Contributor": { "ContactKey": "7ba3598b-40ff-428c-854e-71b830a4a15e", "PictureUrl": "sample string 2", "FirstName": "sample string 3", "LastName": "sample string 4", "DisplayName": "sample string 5", "ViewUrl": "sample string 6" }, "ParentContainer": { "ContainerKey": "3a48c617-29dc-4682-abdc-3ec19cb6423b", "ContainerName": "sample string 2", "ContainerType": "sample string 3" }, "ActionText": "sample string 4", "CreateDate": "2024-12-14T14:24:41.659058Z", "PublishedDate": "2024-12-14T14:24:41.659058Z", "PublicationStatus": "published", "Date01": "2024-12-14T14:24:41.659058Z", "Date02": "2024-12-14T14:24:41.659058Z", "HasRecommended": true, "HasReplied": true, "Bool01": true, "Bool02": true, "ItemType": "sample string 13", "LinkToViewItem": "sample string 14", "Tags": [ { "Tag": "sample string 1", "TagType": "sample string 2" }, { "Tag": "sample string 1", "TagType": "sample string 2" } ], "RecommendationCount": 15, "AttachmentsContainer": { "DocumentKey": "3c634124-5838-49bb-96d5-caaa0c626391", "Attachments": [ { "AttachmentKey": "0c207e27-d1e9-498c-83db-244ca140cc9d", "AttachmentName": "sample string 2", "AttachmentUrl": "sample string 3", "MimeType": "sample string 4" }, { "AttachmentKey": "0c207e27-d1e9-498c-83db-244ca140cc9d", "AttachmentName": "sample string 2", "AttachmentUrl": "sample string 3", "MimeType": "sample string 4" } ] }, "ResponseCount": 16, "Text01": "sample string 17", "Text02": "sample string 18", "Text03": "sample string 19", "Text04": "sample string 20", "FeaturedImageUrl": "sample string 21", "ThreadKey": "3feda3cf-497e-4678-a0f7-14a9ac918147", "Marker": "sample string 23" } ]
application/xml, text/xml
<ArrayOfDataFeedItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.DataFeed"> <DataFeedItem> <ActionText>sample string 4</ActionText> <AttachmentsContainer> <Attachments> <DataFeedAttachment> <AttachmentKey>0c207e27-d1e9-498c-83db-244ca140cc9d</AttachmentKey> <AttachmentName>sample string 2</AttachmentName> <AttachmentUrl>sample string 3</AttachmentUrl> <MimeType>sample string 4</MimeType> </DataFeedAttachment> <DataFeedAttachment> <AttachmentKey>0c207e27-d1e9-498c-83db-244ca140cc9d</AttachmentKey> <AttachmentName>sample string 2</AttachmentName> <AttachmentUrl>sample string 3</AttachmentUrl> <MimeType>sample string 4</MimeType> </DataFeedAttachment> </Attachments> <DocumentKey>3c634124-5838-49bb-96d5-caaa0c626391</DocumentKey> </AttachmentsContainer> <Body>sample string 3</Body> <Bool01>true</Bool01> <Bool02>true</Bool02> <Contributor> <ContactKey>7ba3598b-40ff-428c-854e-71b830a4a15e</ContactKey> <DisplayName>sample string 5</DisplayName> <FirstName>sample string 3</FirstName> <LastName>sample string 4</LastName> <PictureUrl>sample string 2</PictureUrl> <ViewUrl>sample string 6</ViewUrl> </Contributor> <CreateDate>2024-12-14T09:24:41.659058-05:00</CreateDate> <Date01>2024-12-14T09:24:41.659058-05:00</Date01> <Date02>2024-12-14T09:24:41.659058-05:00</Date02> <FeaturedImageUrl>sample string 21</FeaturedImageUrl> <HasRecommended>true</HasRecommended> <HasReplied>true</HasReplied> <ItemKey>ea749b4b-142b-4ed4-86fc-ebee52a7a291</ItemKey> <ItemType>sample string 13</ItemType> <LinkToViewItem>sample string 14</LinkToViewItem> <Marker>sample string 23</Marker> <ParentContainer> <ContainerKey>3a48c617-29dc-4682-abdc-3ec19cb6423b</ContainerKey> <ContainerName>sample string 2</ContainerName> <ContainerType>sample string 3</ContainerType> </ParentContainer> <PublishedDate>2024-12-14T09:24:41.659058-05:00</PublishedDate> <RecommendationCount>15</RecommendationCount> <ResponseCount>16</ResponseCount> <Tags xmlns:d3p1="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Tagging"> <d3p1:ItemTagResponse> <d3p1:Tag>sample string 1</d3p1:Tag> <d3p1:TagType>sample string 2</d3p1:TagType> </d3p1:ItemTagResponse> <d3p1:ItemTagResponse> <d3p1:Tag>sample string 1</d3p1:Tag> <d3p1:TagType>sample string 2</d3p1:TagType> </d3p1:ItemTagResponse> </Tags> <Text01>sample string 17</Text01> <Text02>sample string 18</Text02> <Text03>sample string 19</Text03> <Text04>sample string 20</Text04> <ThreadKey>3feda3cf-497e-4678-a0f7-14a9ac918147</ThreadKey> <Title>sample string 2</Title> </DataFeedItem> <DataFeedItem> <ActionText>sample string 4</ActionText> <AttachmentsContainer> <Attachments> <DataFeedAttachment> <AttachmentKey>0c207e27-d1e9-498c-83db-244ca140cc9d</AttachmentKey> <AttachmentName>sample string 2</AttachmentName> <AttachmentUrl>sample string 3</AttachmentUrl> <MimeType>sample string 4</MimeType> </DataFeedAttachment> <DataFeedAttachment> <AttachmentKey>0c207e27-d1e9-498c-83db-244ca140cc9d</AttachmentKey> <AttachmentName>sample string 2</AttachmentName> <AttachmentUrl>sample string 3</AttachmentUrl> <MimeType>sample string 4</MimeType> </DataFeedAttachment> </Attachments> <DocumentKey>3c634124-5838-49bb-96d5-caaa0c626391</DocumentKey> </AttachmentsContainer> <Body>sample string 3</Body> <Bool01>true</Bool01> <Bool02>true</Bool02> <Contributor> <ContactKey>7ba3598b-40ff-428c-854e-71b830a4a15e</ContactKey> <DisplayName>sample string 5</DisplayName> <FirstName>sample string 3</FirstName> <LastName>sample string 4</LastName> <PictureUrl>sample string 2</PictureUrl> <ViewUrl>sample string 6</ViewUrl> </Contributor> <CreateDate>2024-12-14T09:24:41.659058-05:00</CreateDate> <Date01>2024-12-14T09:24:41.659058-05:00</Date01> <Date02>2024-12-14T09:24:41.659058-05:00</Date02> <FeaturedImageUrl>sample string 21</FeaturedImageUrl> <HasRecommended>true</HasRecommended> <HasReplied>true</HasReplied> <ItemKey>ea749b4b-142b-4ed4-86fc-ebee52a7a291</ItemKey> <ItemType>sample string 13</ItemType> <LinkToViewItem>sample string 14</LinkToViewItem> <Marker>sample string 23</Marker> <ParentContainer> <ContainerKey>3a48c617-29dc-4682-abdc-3ec19cb6423b</ContainerKey> <ContainerName>sample string 2</ContainerName> <ContainerType>sample string 3</ContainerType> </ParentContainer> <PublishedDate>2024-12-14T09:24:41.659058-05:00</PublishedDate> <RecommendationCount>15</RecommendationCount> <ResponseCount>16</ResponseCount> <Tags xmlns:d3p1="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Tagging"> <d3p1:ItemTagResponse> <d3p1:Tag>sample string 1</d3p1:Tag> <d3p1:TagType>sample string 2</d3p1:TagType> </d3p1:ItemTagResponse> <d3p1:ItemTagResponse> <d3p1:Tag>sample string 1</d3p1:Tag> <d3p1:TagType>sample string 2</d3p1:TagType> </d3p1:ItemTagResponse> </Tags> <Text01>sample string 17</Text01> <Text02>sample string 18</Text02> <Text03>sample string 19</Text03> <Text04>sample string 20</Text04> <ThreadKey>3feda3cf-497e-4678-a0f7-14a9ac918147</ThreadKey> <Title>sample string 2</Title> </DataFeedItem> </ArrayOfDataFeedItem>