Get an export of an activity's reporting data in CSV or JSON format.
Resource URL
/v2/applications/{communityApiKeyName}/touchpoint/activities/{activityID}/export
Available methods
| Method | Description |
|---|---|
| GET |
Returns a response with the reporting data of an activity,
including
|
Parameters
Accept header to
application/json to return a response in JSON format.
Otherwise, the response returned will be in CSV format.
| Operation | Description | Example |
|---|---|---|
| Refine your response by providing a date range. | Optional. Add a
dateRange to limit the range of the data that
is returned.
dateRange must include the field
timeFrame followed by to and/or from
timestamps to specify the
dateRange.
Note: Timestamps must be in ISO 8601.
|
|
Example: GET Request
Get January 2023 reporting data for one activity in the form of a CSV file.
https://api.{region}.alida.com/v2/applications/{communityApiKeyName}/touchpoint/activities/{activityID}/export?
dateRange=timeFrame(from:2023-01-01T00:00:00.000Z, to:2023-02-01T00:00:00.000Z)Example: GET Response
Sample CSV headers
Distribution Name | Status | ActivityStart | ActivityCompleted |
Source | Ease of finding info |
Find all info_Yes | Find all info_No | Text Entry | Sentiment |
Any Issues?_Yes, and I would like to share at this time |
Any Issues?_Yes, but I do not want to share at this time |
Any Issues?_No |
Issue Experienced | Sentiment | Device Type | Browser