Link Search Menu Expand Document

Updated Fri Mar 5th 2021, 12:17 UTC

Export Analytics Reports

POST /analytics/export{?account,startDate,endDate,reports[]}

Allows users to export analytics reports about a certain account. Report types can be any of the following three: ‘users_by_organization’, ‘message_deliverability’, ‘user_engagement’ Each report will be calculated as a CSV and emailed as an attachment to the user.

Examples

Exporting all analytics reports

Request

POST /analytics/export?account=/accounts/my_account&startDate=2020-04-01&endDate=2020-04-08&reports[]=users_by_organization&reports[]=message_deliverability&reports[]=user_engagement
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X POST /analytics/export?account=/accounts/my_account&startDate=2020-04-01&endDate=2020-04-08&reports[]=users_by_organization&reports[]=message_deliverability&reports[]=user_engagement
    

Response

Status

202

Response Type

No body


© 2021 TextUs