TAtalon
Customer data

Get customer's activity 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 the summary report of a given customer in the given application, in a time range.

get/v1/applications/{applicationId}/customer_activity_reports/{customerId}

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.

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

integrationIdstring string required

The integration ID set by your integration layer.

createdstring date-time required

The time this entity was created.

namestring required

The name for this customer profile.

customerIdinteger required

The internal Talon.One ID of the customer.

lastActivitystring date-time

The last activity of the customer.

couponRedemptionsinteger required

Number of coupon redemptions in all customer campaigns.

couponUseAttemptsinteger required

Number of coupon use attempts in all customer campaigns.

couponFailedAttemptsinteger required

Number of failed coupon use attempts in all customer campaigns.

accruedDiscountsnumber required

Number of accrued discounts in all customer campaigns.

accruedRevenuenumber required

Amount of accrued revenue in all customer campaigns.

totalOrdersinteger required

Number of orders in all customer campaigns.

totalOrdersNoCouponinteger required

Number of orders without coupon used in all customer campaigns.

campaignNamestring required

The name of the campaign this customer belongs to.

Example response

{
  "integrationId": "URNGV8294NV",
  "created": "2020-02-07T08:15:22Z"
}

Changes

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