TAtalon
Customer data

Get customer's analytics report

[!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.

Fetch analytics for a given customer in the given application.

get/v1/applications/{applicationId}/customers/{customerId}/analytics

Request

Path parameters

applicationIdinteger required

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

customerIdinteger required

The value of the id property of a customer profile. Get it with the List Application's customers endpoint.

Query parameters

pageSizeinteger

The number of items in the response.

skipinteger

The number of items to skip when paging through large result sets.

sortstring

The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with -.

Note: You may not be able to use all fields for sorting. This is due to performance limitations.

Response

OK

acceptedCouponsinteger required

Total accepted coupons for this customer.

createdCouponsinteger required

Total created coupons for this customer.

freeItemsinteger required

Total free items given to this customer.

totalOrdersinteger required

Total orders made by this customer.

totalDiscountedOrdersinteger required

Total orders made by this customer that had a discount.

totalRevenuenumber required

Total Revenue across all closed sessions.

totalDiscountsnumber required

The sum of discounts that were given across all closed sessions.

Changes

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