/api/datasets/{dataset_id}/events/

get

https://analytics.pypestream.com/api/datasets/{dataset_id}/events/

Events: Specific user actions (e.g., clicks, page views, form submissions, Pype escalations) or system occurrences (e.g., Pype session started) captured by Analytics. They form the basis of most analyses.

Note: this endpoint is for overview/exploration purposes. For data export use batch_exports endpoints.

Get a list of events for a specific dataset.

Path Params

dataset_id

string

required

Dataset ID of the dataset you're trying to access. To find the ID of the dataset, make a call to /api/datasets/.

Query Params

after

date-time

Only return events with a timestamp after this time.

before

date-time

Only return events with a timestamp before this time.

distinct_id

integer

Filter list by distinct id.

event

string

Filter list by event. For example user sign up or $pageview.

format

string

enum

Allowed:

limit

integer

The maximum number of results to return

maskPii

boolean

If true, personally identifiable information is masked in the properties of returned events. A property is considered to contain PII if a retention period is set for it.

offset

integer

The initial index from which to return the results.

person_id

integer

Filter list by person id.

properties

array of objects

Filter events by event property, person property, cohort, groups and more.

properties

select

array of strings

(Experimental) JSON-serialized array of PypeQL expressions to return

select

where

array of strings

(Experimental) JSON-serialized array of PypeQL expressions that must pass

where

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

200