Export users
POST https://api.chatbot.com/users/export
Properties
parameter | type | required | default |
---|---|---|---|
sort | Object | optional | |
sort.field | createdAt , lastSeen | optional | createdAt |
sort.order | asc , desc | optional | desc |
match | all , any | optional | all |
filters | Filter[1,5] | optional | |
users | String(24)[1,1000] | optional | |
fields | Field[1,16] | optional |
Note:
users
parameter is not allowed simultaneously withfilters
and/ormatch
Export fields
field | headline |
---|---|
default_name | Name |
default_email | Email |
createdAt | First Seen |
lastSeen | Last Seen |
default_source | Integration |
default_url | Source |
userId | User ID |
default_avatar | Avatar |
default_language | Language |
default_timezone | Timezone |
default_gender | Gender |
default_ip | IP |
default_city | City |
default_region | Region |
default_country | Country |
default_referrer | Referrer |
default_username | Username |