Loading ...

REST API: Get Content Read Report | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Get Content Read Report
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 22

REST API: Get Content Read Report

0 
 /5
0 (0votes)
Open API Guide
GET/api/content/{ContentID}/readreport

Enables administrators and developers to programmatically retrieve a list of people who viewed and confirmed they read content. Supported content types: Articles, blogs, CMS pages, files, ideas, videos, wiki pages.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.

Required Parameters

ParameterTypeRequiredLocationDescription
ContentIDIntegerYESPathUnique ID of the content
EntityTypeStringYESQueryID of the content type. Article = 3, Blog = 4 CMS page = 12, File = 14, Idea = 44, Video = 7 Wiki page = 9
VersionIDIntegerYESQueryIf 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
SpaceIDIntegerYESQueryID of the space the content is in

Optional Parameters

ParameterTypeRequiredLocationDescription
ReadFilterIntegerNOQueryFilters 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
SortColumnStringNOQuerySpecifies the property to sort results by. Default value is 1. Display name = 1 Date confirmed = 2
StartPageIntegerNOQuerySpecifies the starting page of list to be returned. Default value is 1.
PageLengthIntegerNOQuerySpecifies the number of results to be returned per page. Default value is 25.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/content/6717/readreport?EntityType=4&SpaceID=252&VersionID=7&ReadFilter=2

Success Response

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

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid. (contentID, entityType, versionID, spaceID)Verify the request payload against the required parameters.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
404 Not FoundThe specified content was not found.Verify the contentID is correct.
500 Server ErrorInternal failure.Retry later.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages