Loading ...

REST API: Get Most Viewed Content | Communifire Documentation

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

REST API: Get Most Viewed Content

0 
 /5
0 (0votes)

Get Most Viewed Content

GET /api/analytics/content/viewed

Get a list of the most viewed 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.
Optional Parameters How to use Description
SpaceID &SpaceID=x - Used in the request URL as a query parameter Specifies the space to get top 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/viewed&SpaceID=252&ContentTypeCSV-3,4&FromDate=20210426&ToDate=20210525&Size=5

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-7769",
      "Title": "Volunteer Opportunities",
      "Summary": "Volunteering is a great way to give back to your community. Read this article to find out about upcoming volunteer opportunities.",
      "IsIsolated": false,
      "CategoryID": 2010,
      "ParentCategoryID": 0,
      "WallPostToUserID": 0,
      "DateCreated": "2021-05-13T21:41:49.663",
      "DatePublished": "2021-05-13T21:41:49.663",
      "DateUpdated": "2021-05-13T21:50:46.353",
      "ShowDate": true,
      "ShowMetaData": true,
      "DateCreatedString": "11 days ago",
      "DatePublishedString": "11 days ago",
      "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": 7769,
      "ContentURL": "/spaces/252/human-resources/articles/news/7769/volunteer-opportunities",
      "ContentImageURL": "https://myintranet.communifire.com/assets/Themes/default/images/photo-first.gif",
      "ContentCommentsURL": "/spaces/252/human-resources/articles/news/7769/volunteer-opportunities#comments",
      "ContentMediaServerID": 0,
      "WallID": 0,
      "ContentStub": "volunteer-opportunities",
      "GreatGrandParentContentID": 0,
      "ContentCategoryStub": "news",
      "Tags": "",
      "ForumPostForumID": 0,
      "ForumPostTopicID": 0,
      "EntityIconCssClass": "icon-file",
      "IsExternalContent": false,
      "ParentEntityType": 0,
      "ParentContentID": 0,
      "ContentDetailImageURL": "https://myintranet.communifire.com/assets/Themes/default/images/photo-placeholder.gif",
      "UserIsProfilePublic": false,
      "UserIsActivated": false,
      "CommentCount": 0,
      "LikeCount": 1,
      "PageViews": 2,
      "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": "9-6708",
      "Title": "Company Handbook",
      "Summary": "Taking pride in your work may sound like a stretch when you’re assigned to some miserable and mundane task. But it’s the most important thing a manager can do for his staff. And, while some jobs come with more built-in glitz than others, any job is pot...",
      "IsIsolated": false,
      "CategoryID": -1,
      "WallPostToUserID": 0,
      "DateCreated": "2017-09-05T06:58:23.11",
      "DatePublished": "2017-09-05T06:58:23.11",
      "DateUpdated": "2020-09-04T21:50:01.8",
      "ShowDate": true,
      "ShowMetaData": true,
      "DateCreatedString": "9/4/2017",
      "DatePublishedString": "9/4/2017",
      "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": 9,
      "EntityTypeText": "Wiki",
      "ContentID": 6708,
      "ContentURL": "/spaces/252/human-resources/wiki/view/6708/company-handbook",
      "ContentImageURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files/993a11a0-1d71-4869-8e08-2539b74a6a1a.png",
      "ContentCommentsURL": "/spaces/252/human-resources/wiki/view/6708/company-handbook#comments",
      "ContentMediaServerID": 0,
      "WallID": 0,
      "ContentStub": "company-handbook",
      "GreatGrandParentContentID": 0,
      "ContentCategoryStub": "",
      "Tags": "hr,company,culture,documents,handbook",
      "ForumPostForumID": 0,
      "ForumPostTopicID": 0,
      "EntityIconCssClass": "icon-book",
      "IsExternalContent": false,
      "ParentEntityType": 0,
      "ParentContentID": 0,
      "ContentDetailImageURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files/993a11a0-1d71-4869-8e08-2539b74a6a1a.png",
      "UserIsProfilePublic": false,
      "UserIsActivated": false,
      "CommentCount": 2,
      "LikeCount": 5,
      "PageViews": 800,
      "Rating": 4.88,
      "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-6715",
      "Title": "12 Reasons to Celebrate at Work",
      "Summary": "I was excited to find this brave little challenge in the sea of productivity and negativity complaints. Here’s a person, I thought, who is not out to brainwash and slave-drive her fellow coworkers. But to refresh and entertain!",
      "IsIsolated": false,
      "CategoryID": 2010,
      "ParentCategoryID": 0,
      "WallPostToUserID": 0,
      "DateCreated": "2021-03-29T17:00:56.663",
      "DatePublished": "2021-03-29T17:00:56.663",
      "DateUpdated": "2021-04-01T17:23:02.047",
      "ShowDate": true,
      "ShowMetaData": true,
      "DateCreatedString": "3/29/2021",
      "DatePublishedString": "3/29/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": 6715,
      "ContentURL": "/spaces/252/human-resources/articles/news/6715/12-reasons-to-celebrate-at-work",
      "ContentImageURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files/3643a3f6-f84a-4d71-8448-11a8bd6cf596.png",
      "ContentCommentsURL": "/spaces/252/human-resources/articles/news/6715/12-reasons-to-celebrate-at-work#comments",
      "ContentMediaServerID": 0,
      "WallID": 0,
      "ContentStub": "12-reasons-to-celebrate-at-work",
      "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/3643a3f6-f84a-4d71-8448-11a8bd6cf596.png",
      "UserIsProfilePublic": false,
      "UserIsActivated": false,
      "CommentCount": 2,
      "LikeCount": 6,
      "PageViews": 182,
      "Rating": 4.62,
      "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-6716",
      "Title": "How to Get Your Employees to Use Technology",
      "Summary": "The particular individuals who left these comments on my site do not work for the same company. I don’t know about you, but I definitely sense office drama brewing beneath the surface...",
      "IsIsolated": false,
      "CategoryID": 2010,
      "ParentCategoryID": 0,
      "WallPostToUserID": 0,
      "DateCreated": "2021-03-25T17:00:56.45",
      "DatePublished": "2021-03-25T17:00:56.45",
      "DateUpdated": "2021-04-01T17:23:09.46",
      "ShowDate": true,
      "ShowMetaData": true,
      "DateCreatedString": "3/25/2021",
      "DatePublishedString": "3/25/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": 6716,
      "ContentURL": "/spaces/252/human-resources/articles/news/6716/how-to-get-your-employees-to-use-technology",
      "ContentImageURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files/2322daba-2af6-493f-9391-c92c845624ab.png",
      "ContentCommentsURL": "/spaces/252/human-resources/articles/news/6716/how-to-get-your-employees-to-use-technology#comments",
      "ContentMediaServerID": 0,
      "WallID": 0,
      "ContentStub": "how-to-get-your-employees-to-use-technology",
      "GreatGrandParentContentID": 0,
      "ContentCategoryStub": "news",
      "Tags": "engagement,communication,process,story",
      "ForumPostForumID": 0,
      "ForumPostTopicID": 0,
      "EntityIconCssClass": "icon-file",
      "IsExternalContent": false,
      "ParentEntityType": 0,
      "ParentContentID": 0,
      "ContentDetailImageURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files/2322daba-2af6-493f-9391-c92c845624ab.png",
      "UserIsProfilePublic": false,
      "UserIsActivated": false,
      "CommentCount": 3,
      "LikeCount": 6,
      "PageViews": 674,
      "Rating": 4.53,
      "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