API Reference

/api/datasets/{dataset_id}/persons/

get
https://analytics.pypestream.com/api/datasets//persons/

Person / Persons: A feature within Data Management representing individual users tracked by Analytics. The "Persons" list allows accessing detailed profiles for each user, showing their associated properties, event history, cohort memberships, and related replays.

Get a list of persons for a specific dataset.

Path Params
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
string

Filter list by distinct id.

string

Filter persons by email (exact match)

string
enum
Allowed:
integer

Number of results to return per page.

integer

The initial index from which to return the results.

properties
array of objects

Filter Persons by person properties.

properties
string

Search persons, either by email (full text search) or distinct_id (exact match).

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Updated 9 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/csv

Updated 9 months ago

Did this page help you?