analytics

Query analytics events

Returns paginated raw engagement events (views and clicks) for the authenticated organization, filtered by date range and optional storyId / versionId / userEmail.

Plan

This endpoint is available on the Team plan only.

Date Range

Both dateFrom and dateTo are required ISO 8601 strings. The dateTo boundary is inclusive (events on the supplied day are returned). The maximum range is 92 days (3 months).

Pagination

Results are paginated with a fixed page size of 1000. Pages are 1-indexed. Use the pagination.hasMore flag to determine whether to request the next page.

Filtering by user

Pass userEmail to restrict results to events on versions created by that user. The email is resolved to a user in the authenticated organization before querying.

get/v2/analytics/events

Request

Base URL
https://api.storydoc.com
Auth
HTTP bearer

Query parameters

dateFromstring date-time required

Example:2026-01-01T00:00:00Z

Inclusive start of the date range (ISO 8601, UTC)

dateTostring date-time required

Example:2026-03-31T23:59:59Z

Inclusive end of the date range (ISO 8601, UTC). Must be at most 92 days after dateFrom.

storyIdstring

Example:61b1e50223b713000a41ca74

Restrict events to a single story

versionIdstring

Example:65a1e50223b713000a41ca99

Restrict events to a single version

userEmailstring email

Example:sender@company.com

Restrict events to versions created by the user with this email. Must match a user in the authenticated organization.

pageinteger

Example:1

1-indexed page number. Defaults to 1.

Response

Events retrieved successfully

Example response

{
  "data": [
    {
      "sessionId": "1c2f0c2c-9b7e-4f4a-9f8e-3a3a3a3a3a3a",
      "eventId": "evt_8a1c0a16d2b14e9c",
      "visitorId": "vis_aa11bb22cc33dd44",
      "timestamp": "2026-04-15T14:32:11.000Z",
      "storyId": "61b1e50223b713000a41ca74",
      "storyTitle": "Sales Presentation Template",
      "versionId": "65a1e50223b713000a41ca99",
      "versionTitle": "ACME Corp - Q2 Pitch",
      "versionCreatedAt": "2026-04-10T09:15:00.000Z",
      "prospectName": "Jane Cooper",
      "prospectEmail": "jane.cooper@acme.com",
      "prospectPosition": "VP Marketing",
      "eventName": "view_slide_3",
      "eventCategory": "view",
      "deviceType": "desktop",
      "deviceTypeName": "Mac",
      "eventUrl": "https://view.storydoc.com/abc123",
      "locationCity": "New York",
      "locationLatitude": 40.7128,
      "locationLongitude": -74.006
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 1000,
    "total": 12453,
    "totalPages": 13,
    "hasMore": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.