JobAidAnalytics

A request or response body; the type column links to the schemas it refers to.

JobAidAnalytics

FieldTypeRequiredDescription
job_aid_idstring (uuid)yes—
view_countintegeryes

Every recorded open, page and file opens alike, by anyone — administrators previewing included.

page_view_countintegeryes

Opens of the aid's page alone — what the job_aid_viewed rule counts.

unique_viewersintegeryes—
last_viewed_atstring (date-time) | nullyes—
viewersarray of JobAidVieweryes

Everyone who has opened the aid, most recent first.

jsonExample
{
  "job_aid_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "view_count": 0,
  "page_view_count": 0,
  "unique_viewers": 0,
  "last_viewed_at": "2026-01-01T00:00:00.000Z",
  "viewers": [
    {
      "user_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "display_name": "string",
      "email": "string",
      "view_count": 0,
      "first_viewed_at": "2026-01-01T00:00:00.000Z",
      "last_viewed_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}