Loading ...

REST API: Get Top Content | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Analytics » REST API: Get Top Content
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 3

REST API: Get Top Content

0 
 /5
0 (0votes)

Get Top Content

GET /api/analytics/content/top

Get a list of the top viewed, commented, liked, rated, or downloaded content. Valid for Communifire version 7.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
7.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)

Communifire REST API key for the Communifire portal you are making the call for.
Action &Action=x - Used in the request URL as a query parameter The ID of the activity action to get analytics for.
  • Comment = 6
  • Download = 110
  • Like = 25
  • Rating = 28
  • View = 64
Optional Parameters How to use Description
SpaceID &SpaceID=x - Used in the request URL as a query parameter Specifies the space to get content for. The ID for the top level community is 0.
ContentTypeCSV &ContentTypeCSV=x - Used in the request URL as a query parameter Specifies the content types to return. See REST API: System Entity Types .
FromDate &FromDate=x - Used in the request URL as a query parameter Specifies the date range. The date format is YYYY-MM-DD:HH:mm:ssZ.
ToDate &ToDate=x - Used in the request URL as a query parameter Specifies the date range. The date format is YYYY-MM-DD:HH:mm:ssZ.
Size &Size=x - Used in the request URL as a query parameter Specifies the number of content to return. The default value is 10.

Example Request

GET https://myintranet.communifire.com/api/analytics/content/top?Action=1&FromDate=20210426&ToDate=20210525&SpaceID=252&ContentTypeCSV=3,4&Size=3

Example Response

Content JSON object is returned as ResponseData.

{
  "IsError": false,
  "ResponseData": [
    {
      "IDProperty": "3-7194",
      "Title": "The Value of Processes and Procedures in the Workplace",
      "Summary": "Nothing kills a project like a little lack of sharing and collaborating on standard processes and procedures. And, having spent my whole life in IT, I’ve seen the proof of this first hand. Here's how to fix it...",
      "IsIsolated": false,
      "CategoryID": 2010,
      "ParentCategoryID": 0,
      "WallPostToUserID": 0,
      "DateCreated": "2021-03-31T17:00:01.02",
      "DatePublished": "2021-03-31T17:00:01.02",
      "DateUpdated": "2021-05-13T21:40:17.98",
      "ShowDate": true,
      "ShowMetaData": true,
      "DateCreatedString": "3/31/2021",
      "DatePublishedString": "3/31/2021",
      "AuthorUserID": 376,
      "AuthorUsername": "admin",
      "AuthorUserDisplayName": "Alexis Fox",
      "AuthorUserAvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/376/1c32c413-8025-4da5-b23a-575ab251faf4.png",
      "AuthorUserProfileURL": "https://myintranet.communifire.com/people/admin",
      "SpaceID": 252,
      "ContentStatusID": 1,
      "ContentCurrentWorkFlowStepID": 0,
      "SpaceName": "Human Resources",
      "SpaceURL": "/spaces/252/human-resources/hr-homepage",
      "EntityType": 3,
      "EntityTypeText": "Article",
      "ContentID": 7194,
      "ContentURL": "/spaces/252/human-resources/articles/news/7194/the-value-of-processes-and-procedures-in-the-workplace",
      "ContentImageURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files/ad3230eb-a516-4b34-8367-fba2be4bd6b3.png",
      "ContentCommentsURL": "/spaces/252/human-resources/articles/news/7194/the-value-of-processes-and-procedures-in-the-workplace#comments",
      "ContentMediaServerID": 0,
      "WallID": 0,
      "ContentStub": "the-value-of-processes-and-procedures-in-the-workplace",
      "GreatGrandParentContentID": 0,
      "ContentCategoryStub": "news",
      "Tags": "",
      "ForumPostForumID": 0,
      "ForumPostTopicID": 0,
      "EntityIconCssClass": "icon-file",
      "IsExternalContent": false,
      "ParentEntityType": 0,
      "ParentContentID": 0,
      "ContentDetailImageURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files/ad3230eb-a516-4b34-8367-fba2be4bd6b3.png",
      "UserIsProfilePublic": false,
      "UserIsActivated": false,
      "CommentCount": 1,
      "LikeCount": 0,
      "PageViews": 72,
      "Rating": 0.0,
      "IsComment": false,
      "IsSpaceLevel": false,
      "IsFeatured": false,
      "IsLatest": false,
      "IsContentPubliclyAccessible": false,
      "IsAddedFromActivityStream": false,
      "ShowRating": true,
      "ShowViewCount": true,
      "ShowCommentCount": true,
      "EventStartDate": "0001-01-01T00:00:00",
      "IsRecurringTime": false,
      "EventEndDate": "0001-01-01T00:00:00",
      "EventScheduleStartDate": "0001-01-01T00:00:00",
      "EventScheduleEndDate": "0001-01-01T00:00:00",
      "EventCountryID": 0,
      "EventStateID": 0,
      "EventMetroID": 0,
      "EventIsAllDay": false,
      "EventIsPrivate": false,
      "EventTypeID": 0,
      "SpaceVisibility": 0,
      "TotalChildRecords": 0,
      "IsAwardPost": false,
      "AwardID": 0,
      "MembershipContentID": 0,
      "ConnectedToUser": false,
      "IssueCommentIsProjectActive": false,
      "IssueCommentIsInternal": false,
      "IssueCommentIssueID": 0,
      "ActivityActionEnum": 0,
      "ActivityLogBrowserType": 0,
      "ActivityLogOperatingSys": 0,
      "ActivityLogUserID": 0,
      "IndexedContentType": 0,
      "IsRequiredReading": false,
      "IsRequiredReadingConfirmed": false,
      "ContentVersionID": 0,
      "IsAnonymous": false
    },
    {
      "IDProperty": "3-7240",
      "Title": "6 Employee Engagement Tips to Keep Long-Term Employees Excited About Work",
      "Summary": "There's a common misconception that U.S. employees have become \\"job jumpers,\\" especially over the last decade. Whether it's a new hire, or a team member with 15 years on the job, cultivating engagement is a vital business activity. Here are 6 employee engagement tips to help you retain your best team members."",
      "IsIsolated": false,
      "CategoryID": 2009,
      "ParentCategoryID": 0,
      "WallPostToUserID": 0,
      "DateCreated": "2020-03-04T18:00:45.047",
      "DatePublished": "2020-03-04T18:00:45.047",
      "DateUpdated": "2020-09-04T18:44:05.48",
      "ShowDate": true,
      "ShowMetaData": true,
      "DateCreatedString": "3/4/2020",
      "DatePublishedString": "3/4/2020",
      "AuthorUserID": 376,
      "AuthorUsername": "admin",
      "AuthorUserDisplayName": "Alexis Fox",
      "AuthorUserAvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/376/1c32c413-8025-4da5-b23a-575ab251faf4.png",
      "AuthorUserProfileURL": "https://myintranet.communifire.com/people/admin",
      "SpaceID": 252,
      "ContentStatusID": 5,
      "ContentCurrentWorkFlowStepID": 0,
      "SpaceName": "Human Resources",
      "SpaceURL": "/spaces/252/human-resources/hr-homepage",
      "EntityType": 3,
      "EntityTypeText": "Article",
      "ContentID": 7240,
      "ContentURL": "/spaces/252/human-resources/articles/press-release/7240/6-employee-engagement-tips-to-keep-long-term-employees-excited-about-work",
      "ContentImageURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files/e2c94262-7ada-4d75-a082-2db46bf52bee.png",
      "ContentCommentsURL": "/spaces/252/human-resources/articles/press-release/7240/6-employee-engagement-tips-to-keep-long-term-employees-excited-about-work#comments",
      "ContentMediaServerID": 0,
      "WallID": 0,
      "ContentStub": "6-employee-engagement-tips-to-keep-long-term-employees-excited-about-work",
      "GreatGrandParentContentID": 0,
      "ContentCategoryStub": "press-release",
      "Tags": "",
      "ForumPostForumID": 0,
      "ForumPostTopicID": 0,
      "EntityIconCssClass": "icon-file",
      "IsExternalContent": false,
      "ParentEntityType": 0,
      "ParentContentID": 0,
      "ContentDetailImageURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files/e2c94262-7ada-4d75-a082-2db46bf52bee.png",
      "UserIsProfilePublic": false,
      "UserIsActivated": false,
      "CommentCount": 0,
      "LikeCount": 0,
      "PageViews": 63,
      "Rating": 0.0,
      "IsComment": false,
      "IsSpaceLevel": false,
      "IsFeatured": false,
      "IsLatest": false,
      "IsContentPubliclyAccessible": false,
      "IsAddedFromActivityStream": false,
      "ShowRating": true,
      "ShowViewCount": true,
      "ShowCommentCount": true,
      "EventStartDate": "0001-01-01T00:00:00",
      "IsRecurringTime": false,
      "EventEndDate": "0001-01-01T00:00:00",
      "EventScheduleStartDate": "0001-01-01T00:00:00",
      "EventScheduleEndDate": "0001-01-01T00:00:00",
      "EventCountryID": 0,
      "EventStateID": 0,
      "EventMetroID": 0,
      "EventIsAllDay": false,
      "EventIsPrivate": false,
      "EventTypeID": 0,
      "SpaceVisibility": 0,
      "TotalChildRecords": 0,
      "IsAwardPost": false,
      "AwardID": 0,
      "MembershipContentID": 0,
      "ConnectedToUser": false,
      "IssueCommentIsProjectActive": false,
      "IssueCommentIsInternal": false,
      "IssueCommentIssueID": 0,
      "ActivityActionEnum": 0,
      "ActivityLogBrowserType": 0,
      "ActivityLogOperatingSys": 0,
      "ActivityLogUserID": 0,
      "IndexedContentType": 0,
      "IsRequiredReading": false,
      "IsRequiredReadingConfirmed": false,
      "ContentVersionID": 0,
      "IsAnonymous": false
    },
    {
      "IDProperty": "3-7058",
      "Title": "How to Know If Your Document Management System Needs a Tune-up—or a Trip to the Digital Dump",
      "Summary": "What a Winning Document Management System Looks Like—and How It’s Helping Organizations Thrive Today",
      "IsIsolated": false,
      "CategoryID": 2010,
      "ParentCategoryID": 0,
      "WallPostToUserID": 0,
      "DateCreated": "2019-07-25T19:59:00.77",
      "DatePublished": "2019-07-25T19:59:00.77",
      "DateUpdated": "2019-07-27T01:48:42.283",
      "ShowDate": true,
      "ShowMetaData": true,
      "DateCreatedString": "7/25/2019",
      "DatePublishedString": "7/25/2019",
      "AuthorUserID": 616,
      "AuthorUsername": "haileigh",
      "AuthorUserDisplayName": "Haileigh Jacob",
      "AuthorUserAvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/616/fb65d8cf-2152-4a08-9d39-8963c61a171d.jpeg",
      "AuthorUserProfileURL": "https://myintranet.communifire.com/people/haileigh",
      "SpaceID": 252,
      "ContentStatusID": 1,
      "ContentCurrentWorkFlowStepID": 0,
      "SpaceName": "Human Resources",
      "SpaceURL": "/spaces/252/human-resources/hr-homepage",
      "EntityType": 3,
      "EntityTypeText": "Article",
      "ContentID": 7058,
      "ContentURL": "/spaces/252/human-resources/articles/news/7058/how-to-know-if-your-document-management-system-needs-a-tune-up%E2%80%94or-a-trip-to-the-digital-dump",
      "ContentImageURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files/59fdb7d3-d382-43b3-9335-861ecbc0fce7.png",
      "ContentCommentsURL": "/spaces/252/human-resources/articles/news/7058/how-to-know-if-your-document-management-system-needs-a-tune-up%E2%80%94or-a-trip-to-the-digital-dump#comments",
      "ContentMediaServerID": 0,
      "WallID": 0,
      "ContentStub": "how-to-know-if-your-document-management-system-needs-a-tune-up—or-a-trip-to-the-digital-dump",
      "GreatGrandParentContentID": 0,
      "ContentCategoryStub": "news",
      "Tags": "engagement,communication,collaboration,dms,document management,document-management",
      "ForumPostForumID": 0,
      "ForumPostTopicID": 0,
      "EntityIconCssClass": "icon-file",
      "IsExternalContent": false,
      "ParentEntityType": 0,
      "ParentContentID": 0,
      "ContentDetailImageURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files/59fdb7d3-d382-43b3-9335-861ecbc0fce7.png",
      "UserIsProfilePublic": false,
      "UserIsActivated": false,
      "CommentCount": 0,
      "LikeCount": 0,
      "PageViews": 54,
      "Rating": 0.0,
      "IsComment": false,
      "IsSpaceLevel": false,
      "IsFeatured": false,
      "IsLatest": false,
      "IsContentPubliclyAccessible": false,
      "IsAddedFromActivityStream": false,
      "ShowRating": true,
      "ShowViewCount": true,
      "ShowCommentCount": true,
      "EventStartDate": "0001-01-01T00:00:00",
      "IsRecurringTime": false,
      "EventEndDate": "0001-01-01T00:00:00",
      "EventScheduleStartDate": "0001-01-01T00:00:00",
      "EventScheduleEndDate": "0001-01-01T00:00:00",
      "EventCountryID": 0,
      "EventStateID": 0,
      "EventMetroID": 0,
      "EventIsAllDay": false,
      "EventIsPrivate": false,
      "EventTypeID": 0,
      "SpaceVisibility": 0,
      "TotalChildRecords": 0,
      "IsAwardPost": false,
      "AwardID": 0,
      "MembershipContentID": 0,
      "ConnectedToUser": false,
      "IssueCommentIsProjectActive": false,
      "IssueCommentIsInternal": false,
      "IssueCommentIssueID": 0,
      "ActivityActionEnum": 0,
      "ActivityLogBrowserType": 0,
      "ActivityLogOperatingSys": 0,
      "ActivityLogUserID": 0,
      "IndexedContentType": 0,
      "IsRequiredReading": false,
      "IsRequiredReadingConfirmed": false,
      "ContentVersionID": 0,
      "IsAnonymous": false
    }
  ]
}

 

Please Note Pass application/json as the content type in the header of your request.

Wiki Index

Pages

Intranet Software