Skip to main content

Get report views

GET https://api.rollstack.com/public/v1/reports/{id}/views

Who opened a report and how they read it, as its editors see under Views in the app: each person's visits, time spent and whether they opened it since its last successful run, who it is shared with but hasn't opened it since, and how far into it people read, slide by slide. Editors' own time editing doesn't count. Only its editors may.

Requires the slide_decks:read scope.

Operation ID: getReportViews.

Path parameters

  • id (string, required): The report to act on, by its id from listReports or createReport. Only reports whose type is SlideDeck work here: another type, such as a Google Slides presentation, returns 400. You can also copy it from the report's link in Rollstack: it's the part right after /slides/.

Response 200

Success

application/json

  • visits (number, required): How many times people opened the report to read it, editors' own edits left out. Visits a few minutes apart count as one, and ones under 5 seconds don't count.
  • medianVisitSeconds (number or null, required): How long a visit lasts, as the median in seconds. null with no visits.
  • lastUpdatedAt (string (date-time) or null, required): When the report's last successful run ended, which openedSinceUpdate compares to. null if it never ran.
  • people (array of object, required): Who opened the report, the most recent first.
    • user (object, required)
      • id (number, required): The member's user id, the same as their id in listMembers.
      • name (string, required): The member's name, as shown in Rollstack.
    • visits (number, required): How many times they opened it.
    • seconds (number, required): How long they spent on it in all, in seconds.
    • lastViewedAt (string (date-time), required): When they last had it open.
    • openedSinceUpdate (boolean, required): Whether they opened it since its last successful run, so saw its latest numbers.
  • notOpened (array of object, required): The members it is shared with who haven't opened it since its last successful run, you left out.
    • id (number, required): The member's user id, the same as their id in listMembers.
    • name (string, required): The member's name, as shown in Rollstack.
  • slides (array of object, required): How far into the report people read, slide by slide.
    • slideId (string, required): The slide, as slideId in getReportContent.
    • reach (number, required): The share of visits that reached the slide, from 0 to 1.
    • medianSeconds (number or null, required): How long a visit stays on the slide, as the median in seconds.