Events

Gate responses (completed viewing-gate forms)

A dedicated resource alias of /api/v1/events?type=gate for integrations whose trigger config wants a resource path. Identical rows, cursor, and parameters. Pro plan required; scope readership:read. Event ids are 64-bit. Email-only gates (which store the address on the view session rather than as a form response) do not appear in this feed.

get/api/v1/gate-responses

Request

  • Base URL: https://everypage.co
  • URL: https://everypage.co/api/v1/gate-responses
  • 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

filestring

Only this file's responses (UUID or short id). Unknown or foreign identifiers return an empty list.

sinceinteger

Return responses with id greater than this. Not portable to the other event streams.

limitinteger

Max responses to return (1-100).

Response

Gate responses as type:"gate" events

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.