PSpscrpt
events

List events

Changed on

There may be a delay of several seconds between writing an event and its appearance in this list.

filter[occurred_at][gte] and filter[occurred_at][lt] are required and may be at most 1 day apart; otherwise the request is 400 parameter_invalid. To sync every event, see Syncing.

Expanding a large page can exceed the 5 MiB response cap and return 400 expand_limit_exceeded. Request a smaller page[limit] or fewer expansions.

get/events

Request

  • Base URL
    https://api.pscrpt.com/v1
  • URL
    https://api.pscrpt.com/v1/events
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://api.pscrpt.com/oauth/authorize
      Token URL: https://api.pscrpt.com/oauth/token scopes: events:read

Query parameters

page[limit]integer
page[after]string
filter[type]string
filter[type][in]string[]
filter[profile_id]string
filter[profile_id][in]AudienceProfileId[]
filter[occurred_at][gte]string date-time required

Start of the window, inclusive.

filter[occurred_at][lt]string date-time required

End of the window, exclusive. At most 1 day after filter[occurred_at][gte].

filter[dedupe_id]string
sortstring

Sort field; a leading - is descending and its absence is ascending. Allowed field: occurred_at. Default: -occurred_at.

expandstring[]

Headers

Postscript-Versionstring date
Example:2026-07-23

Overrides the key's pinned API revision for this request.

Response

One page of events.

Example response

{
  "data": [
    {
      "event_type": {
        "first_seen_at": "2026-07-23T17:32:01.123456Z"
      },
      "occurred_at": "2026-07-23T17:32:01.123456Z",
      "profile": {
        "consents": [
          {
            "channel": "sms",
            "consented_at": "2026-07-23T17:32:01.123456Z",
            "identifier": {
              "created_at": "2026-07-23T17:32:01.123456Z",
              "type": "email",
              "updated_at": "2026-07-23T17:32:01.123456Z",
              "verified_at": "2026-07-23T17:32:01.123456Z"
            },
            "method": "checkout",
            "updated_at": "2026-07-23T17:32:01.123456Z"
          }
        ],
        "created_at": "2026-07-23T17:32:01.123456Z",
        "identifiers": [
          {
            "created_at": "2026-07-23T17:32:01.123456Z",
            "type": "email",
            "updated_at": "2026-07-23T17:32:01.123456Z",
            "verified_at": "2026-07-23T17:32:01.123456Z"
          }
        ],
        "updated_at": "2026-07-23T17:32:01.123456Z"
      },
      "received_at": "2026-07-23T17:32:01.123456Z",
      "source": "api"
    }
  ]
}

Changes

  • 8dfa57319d25Revision changes
    • breaking

      added the new required query request parameter filter[occurred_at][lt]

    • breaking

      the query request parameter filter[occurred_at][gte] became required

    • warning

      deleted the query request parameter filter[occurred_at][lte]

  • 2670c64aaec7Revision changes
    • info

      endpoint added