List Consumers

get

https://analytics.zype.com/v3/platform_dynamics/consumers

This endpoint will return consumer analytics data for your property.

Query Params

filters[start_date_gt]

string

Filter records created after the specified start_date (filters[start_date_gte]=2018-11-01). If no start_date is specified, then data returned will date back two weeks ago.

filters[start_date_gte]

string

Filter records created on or after the specified start_date.

filters[start_date_lt]

string

Filter records created before the specified start_date.

filters[start_date_lte]

string

Filter records created on or before the specified start_date.

filters[start_date_eq]

string

Filter records created on the specified start_date. Comparison is date and time specific. If no time values are submitted, 00:00:00 UTC is assumed.

interval

string | null

enum

Shortcut method to group records by time intervals. Accepted values: day, week, month, year.

Allowed:

sort_by

string | null

enum

Sort results by value of a specific property + '_' + sort direction (Example - sort_by=start_date_asc, or sort_by=consumer_email_desc)

Allowed:

Responses

Language

Credentials

Query

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200See below for example responses

422Unprocessable entity