Events

Recent events

Poll recent activity across your files. One stream per call via type: view (default), download, or gate (Pro). Newest first without since; ascending after the cursor with since=<last id>. Cursors are per stream - never reuse a view id on download or gate (view/download ids are 32-bit; gate ids are 64-bit; there is no type=all). file= narrows to one file (UUID or short id; unknown = []). Scope readership:read. Note: the download stream records every explicit download, including your own - unlike the file.downloaded webhook, which only fires for non-owner downloads.

get/api/v1/events

Request

  • Base URL: https://everypage.co
  • URL: https://everypage.co/api/v1/events
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://everypage.co/oauth/authorize, token URL https://everypage.co/oauth/token, scopes: readership:read)

Query parameters

type'view' | 'download' | 'gate'

Which event stream to read. Cursors are NOT portable across types.

filestring

Only this file's events (UUID or short id). Unknown or foreign identifiers return an empty list, not an error.

sinceinteger

Return events with id greater than this (per-type cursor).

limitinteger

Max events to return (1-100).

Response

Events (newest first without since; ascending from the cursor with it)

idinteger

Stable event id for polling/dedup. Per-stream: not comparable across type values.

fileUuidstring uuid
fileNamestring
readAtstring date-time
countrystring

Absent on gate events.

pagesViewedinteger

view events only (always present there, 0 included); absent on download/gate events.

timeMsinteger

Time spent reading, milliseconds. view events only; absent on download/gate events.

type'view' | 'download' | 'gate'

Which stream the event belongs to.

fieldsobject

gate events only: the submitted form fields (e.g. email, name).

Example response

[
  {
    "country": "United Kingdom"
  }
]

Changes

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