Loading ...

REST API: Get Content Read Report | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Get Content Read Report
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 2

REST API: Get Content Read Report

0 
 /5
0 (0votes)

Get Content Read Report

GET /api/content/{ContentID}/readreport

Get a list of people who viewed and confirmed they read content. Supported content types: Articles, blogs, CMS pages, files, ideas, videos, wiki pages. Valid for Communifire version 8.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
8.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.
ContentID Used in the request URL as a path parameter Unique ID of the content.
EntityType &EntityType=x - Used in the request URL as a query parameter

ID of the content type.

  • Article = 3
  • Blog = 4
  • CMS page = 12
  • File = 14
  • Idea = 44
  • Video = 7
  • Wiki page = 9
VersionID &VersionID=x - Used in the request URL as a query parameter If the content is required reading and ReadFilter is set to 2 or 4 (people who read and confirmed or didn't confirm), this parameter filters the report by people who confirmed or didn't confirm they read that particular version.
Otherwise, set to the current version ID of the content.
SpaceID &SpaceID=x - Used in the request URL as a query parameter ID of the space the content is in.
Optional Parameters How to use Description
ReadFilter &ReadFilter=x - Used in the request URL as a query parameter

Filters the report by read status. Default value is 1.

  • People who read = 1
  • People who read and confirmed = 2
  • People who didn't read = 3
  • People who didn't confirm = 4
SortColumn &SortColumn=x - Used in the request URL as a query parameter

Specifies the property to sort results by. Default value is 1.

  • Display name = 1
  • Date confirmed = 2
StartPage &StartPage=x - Used in the request URL as a query parameter Specifies the starting page of list to be returned. Default value is 1.
PageLength &PageLength=x - Used in the request URL as a query parameter Specifies the number of results to be returned per page. Default value is 25.

Example Request

GET https://myintranet.communifire.com/api/content/6717/readreport?EntityType=4&SpaceID=252&VersionID=7&ReadFilter=2

Example Response

Read confirmation JSON is returned as ResponseData.

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "ConfirmationID": 1213,
      "UserID": 595,
      "DateConfirmed": "2021-06-29T20:24:03.783",
      "DateLastViewed": "2021-06-29T20:24:01.383",
      "ViewCount": 1,
      "LastVersionRead": 7,
      "LastVersionReadDate": "2020-09-17T18:46:24.223",
      "LastVersionReadDateString": "9/17/2020 11:46 AM",
      "UserDisplayName": "Ben Newman",
      "UserAvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/595/c990f71d-f5f9-4908-b9e1-32b240cda4ec.jpg",
      "UserProfileURL": "https://myintranet.communifire.com/people/ben-n",
      "DateConfirmedString": "a minute ago",
      "DateLastViewedString": "a minute ago",
      "TenantID": 0
    },
    {
      "ConfirmationID": 1188,
      "UserID": 376,
      "DateConfirmed": "2020-09-17T18:46:31.79",
      "DateLastViewed": "2021-02-13T07:10:59.273",
      "ViewCount": 35,
      "LastVersionRead": 7,
      "LastVersionReadDate": "2020-09-17T18:46:24.223",
      "LastVersionReadDateString": "9/17/2020 11:46 AM",
      "UserDisplayName": "Alexis Fox",
      "UserAvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/376/f9c8486c-f3f3-41f9-9f46-044093247dc9.jpg",
      "UserProfileURL": "https://myintranet.communifire.com/people/admin",
      "DateConfirmedString": "9/17/2020",
      "DateLastViewedString": "2/12/2021",
      "TenantID": 0
    },
    {
      "ConfirmationID": 1198,
      "UserID": 525,
      "DateConfirmed": "2020-09-17T18:48:06.6",
      "DateLastViewed": "2020-09-17T18:48:03.443",
      "ViewCount": 1,
      "LastVersionRead": 7,
      "LastVersionReadDate": "2020-09-17T18:46:24.223",
      "LastVersionReadDateString": "9/17/2020 11:46 AM",
      "UserDisplayName": "Maria Shears",
      "UserAvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/525/859d3bc5-ebff-42cc-83fd-adf1efd42fdb.jpg",
      "UserProfileURL": "https://myintranet.communifire.com/people/maria",
      "DateConfirmedString": "9/17/2020",
      "DateLastViewedString": "9/17/2020",
      "TenantID": 0
    },
    {
      "ConfirmationID": 1196,
      "UserID": 592,
      "DateConfirmed": "2020-09-17T18:47:47.34",
      "DateLastViewed": "2020-09-17T18:47:45.38",
      "ViewCount": 1,
      "LastVersionRead": 7,
      "LastVersionReadDate": "2020-09-17T18:46:24.223",
      "LastVersionReadDateString": "9/17/2020 11:46 AM",
      "UserDisplayName": "June Mattie",
      "UserAvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/592/32b2035c-37ae-42d3-81cc-1548f26c39da.jpg",
      "UserProfileURL": "https://myintranet.communifire.com/people/june-m",
      "DateConfirmedString": "9/17/2020",
      "DateLastViewedString": "9/17/2020",
      "TenantID": 0
    },
    {
      "ConfirmationID": 1195,
      "UserID": 602,
      "DateConfirmed": "2020-09-17T18:47:38.393",
      "DateLastViewed": "2020-09-17T18:47:32.85",
      "ViewCount": 1,
      "LastVersionRead": 7,
      "LastVersionReadDate": "2020-09-17T18:46:24.223",
      "LastVersionReadDateString": "9/17/2020 11:46 AM",
      "UserDisplayName": "Alice Romero",
      "UserAvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/602/06d4a455-7bd7-4c40-9ece-18f12387650c.jpg",
      "UserProfileURL": "https://myintranet.communifire.com/people/alice",
      "DateConfirmedString": "9/17/2020",
      "DateLastViewedString": "9/17/2020",
      "TenantID": 0
    },
    {
      "ConfirmationID": 1193,
      "UserID": 606,
      "DateConfirmed": "2020-09-17T18:47:23.037",
      "DateLastViewed": "2020-09-17T18:47:17.863",
      "ViewCount": 1,
      "LastVersionRead": 7,
      "LastVersionReadDate": "2020-09-17T18:46:24.223",
      "LastVersionReadDateString": "9/17/2020 11:46 AM",
      "UserDisplayName": "Christine Jackson",
      "UserAvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/606/58de29bc-05ed-4eab-b393-4879423f1d90.jpg",
      "UserProfileURL": "https://myintranet.communifire.com/people/christine",
      "DateConfirmedString": "9/17/2020",
      "DateLastViewedString": "9/17/2020",
      "TenantID": 0
    },
    {
      "ConfirmationID": 1190,
      "UserID": 612,
      "DateConfirmed": "2020-09-17T18:46:52.757",
      "DateLastViewed": "2020-09-17T18:46:50.083",
      "ViewCount": 1,
      "LastVersionRead": 7,
      "LastVersionReadDate": "2020-09-17T18:46:24.223",
      "LastVersionReadDateString": "9/17/2020 11:46 AM",
      "UserDisplayName": "Laura Carter",
      "UserAvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/612/265e840e-7cbf-404c-8411-18c4a1bbe303.jpg",
      "UserProfileURL": "https://myintranet.communifire.com/people/laura",
      "DateConfirmedString": "9/17/2020",
      "DateLastViewedString": "9/17/2020",
      "TenantID": 0
    }
  ]
}

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

Wiki Index

Pages

Intranet Software