TAtalon
Campaigns

Export Application analytics aggregated by campaign

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Download a CSV file containing analytics data aggregated by campaign for the campaigns of an Application.

[!tip] If the exported CSV file is too large to view, you can split it into multiple files.

The CSV file contains the following columns:

  • campaign_id: The ID of the campaign. This column also contains labels for the total and influenced values.
  • start_date: The start of the aggregation time frame in UTC.
  • end_date: The end of the aggregation time frame in UTC.
  • revenue: The total, pre-discount value of all items purchased in a customer session.
  • sessions: The number of all closed sessions.
  • average_session_value: The average customer session value, calculated by dividing the revenue value by the number of sessions.
  • average_items_per_session: The number of items from sessions divided by the number of sessions.
  • coupons: The number of times a coupon was successfully redeemed in sessions.
  • discounts: The total value of discounts given for cart items in sessions.
get/v1/applications/{applicationId}/campaign_analytics/export

Request

Path parameters

applicationIdinteger required

The ID of the Application. It is displayed in your Talon.One deployment URL.

Query parameters

campaignIdsstring[]

Filter by one or more Campaign IDs, separated by a comma.

Note: If no campaigns are specified, data for all the campaigns in the Application is returned.

rangeStartstring date-time required

Only return results from after this timestamp.

[!note] Note

  • This must be an RFC3339 timestamp string.
  • You can include a time component in your string, for example, T23:59:59 to specify the end of the day. The time zone setting considered is UTC. If you do not include a time component, a default time value of T00:00:00 (midnight) in UTC is considered.
rangeEndstring date-time required

Only return results from before this timestamp.

[!note] Note

  • This must be an RFC3339 timestamp string.
  • You can include a time component in your string, for example, T23:59:59 to specify the end of the day. The time zone setting considered is UTC. If you do not include a time component, a default time value of T00:00:00 (midnight) in UTC is considered.

Response

OK

Changes

No recorded changes to this operation across all 2 revisions of this API.