Export users and user events

Downloads all subscribers and subscriber events data in csv format.

  • To download subscribers data, specify the attributes query parameter to true, and use the attr, appIds, appIdsRestrictive, grants, since, registeredSince, registeredBefore, foreignKeys query parameters.
  • To download subscriber events data, specify the eventsExport query parameter to true, and use the from and to query parameters.
  • For pagination, use the rpp and page query parameters
SecurityZephrHmacHttp
Request
query Parameters
attributes
boolean

Whether or not to include core attributes

Example: attributes=true
attr
string

Comma-delimited list of user attribute filters in the following format: attributeKey.operation.value or attributeKey.operation.value1.value2.

Example: attr=attr1.contains.a,attr2.equals.3
appIds
string

Comma-delimited list of appIds to retrieve extended profile data for. If appIds is present and attributes isn't, only users with matching extended profiles will be returned. Use all to retrieve all extended profile data.

Example: appIds=quiz1,survey4,all
appIdsRestrictive
boolean

Only include users with a matching extended profile

Example: appIdsRestrictive=true
grants
boolean

Include information about entitlements

Example: grants=true
since
string

Users who were updated after the specified date

Example: since=2020-01-01T00:00:00Z
registeredSince
string

Users who have registered after the specified date

Example: registeredSince=2020-01-01T00:00:00Z
registeredBefore
string

Users who have registered before the specified date

Example: registeredBefore=2020-01-01T00:00:00Z
foreignKeys
boolean

Include user foreign keys

Example: foreignKeys=true
eventsExport
string

Indicates to export the subscriber events csv file

from
string

Subscriber event after the specified date

Example: from=2020-01-01T00:00:00Z
to
string

Subscriber event before the specified date

Example: to=2020-01-02T00:00:00Z
rpp
number
Default: 500

Results per page

Example: rpp=40
page
number
Default: 1

The requested page of results

Example: page=1
Responses
200

OK - User and user event data have been returned successfully

get/v4/user-export
Response samples
application/json
{
  • "results": [
    ],
  • "meta": {
    },
  • "links": {}
}