Read Aggregations

A GET to the /profiles/{profileId}/aggregations endpoint allows your application to retrieve a Profiles Aggregations.

JSON

{
  "profile_id": "922fafaf-1115-2221-a33-fed3333397",
  "shop_days": null,
  "spend_12m": 2000,
  "spend_all": 2000,
  "spend_atv_12m": 2000,
  "spend_atv_all": 2000,
  "spend_first_date": "2020-12-07 13:04:30",
  "spend_last_date": "2020-12-07 13:04:30",
  "dimension_frequency": "F1",
  "dimension_recency": "RC",
  "dimension_join": "JN",
  "channel": null,
  "shop_count": 1,
  "store_join": {
      "id": 1,
      "type": null,
      "name": "Omneo Store",
      "description": null,
      "phone": "1131131",
      "email": null,
      "timezone": null,
      "external_id": "M10",
      "external_code": "10",
      "is_published": true,
      "is_permanently_closed": false,
      "address": null,
      "normal_hours": [],
      "special_hours": [],
      "tags": [],
      "custom_fields": [],
      "created_at": "2020-05-18 08:52:49",
      "updated_at": "2020-08-25 08:59:51"
  },
  "likely_country": null,
  "likely_country_score": null,
  "purchased_brands": [
      "transaction-created"
  ],
  "most_transacted_location": {
      "id": 1,
      "type": null,
      "name": "Omneo Store",
      "description": null,
      "phone": "1131131",
      "email": null,
      "timezone": null,
      "external_id": "M10",
      "external_code": "10",
      "is_published": true,
      "is_permanently_closed": false,
      "address": null,
      "normal_hours": [],
      "special_hours": [],
      "tags": [],
      "custom_fields": [],
      "created_at": "2020-05-18 08:52:49",
      "updated_at": "2020-08-25 08:59:51"
  }
}

📘

Refreshing calculations

Aggregations are automatically recalculated with every transaction made against the profile.
All calculations against a profile are refreshed at once.

Aggregation Properties

Attribute	Description
profile_id READ_ONLY	The profile_id of the profile the aggregation belongs to
shop_days INTEGER	Average days between shops this represents the average of days between the customers purchases.
spend_12m FLOAT	The total dollar value spent over 12 months from the last recalculation date.
spend_all FLOAT	The total dollar value spent since the profile was created
spend_atv_12m FLOAT	The average transaction value over 12 months from the last recalculation date
spend_atv_all FLOAT	The average transaction value since the profile was created
spend_first_date DATE-TIME	Records the date of the Profiles first transaction converted to UTC timezone.
spend_last_date DATE-TIME	Records the last date of the Profiles transacted converted to UTC timezone.
dimension_frequency STRING	A two character code that denotes the frequency the customer shops. F0 = Never shopped F1 = Shopped once F2 = Shopped twice FL = Shopped +3 times & frequency between shops is greater than 30 days FH = Shopped +3 times & frequency between shops is less than 30 days
dimension_recency STRING	A two character code that denotes how recent the customer has shopped R0 - Never shopped RC - Shopped within the last 3 months RS - Shopped within the last 6 months RA - Shopped within the last 12 months RI - Shopped over 12 months ago.
dimension_join STRING	A two character code that denotes the profiles join lifecycle stage. JN = New, where join date is less than or equal to 90 days ago JC = Current, where join date is greater than 90 days but less than or equal to 365 days ago J1 = represents 1 year, where join date is greater than 365 days but less or equal to 730 days J2 = represents 2 years, where join date is greater than 730 days but less or equal to 1095 days J3, J4, etc
channel STRING	A two character code that denotes the channels the customer has used to shop CM - Point of Sale, and Website CF - Point of Sale only CO- Website Only
shop_count INTEGER	The count of total profile transactions, with transactions greater than $0
store_join STRING	the store of the profiles first transaction. This is the first store the profile shopped at
likely_country STRING	The likely country of this profile. This is the result of an internal calculation of recent transactions, joined location, preferred location and stored addresses
likely_country_score INTEGER	This is a numerical score given to the strength of the prediction. with 1 being the highest
purchased_brands ARRAY	An array representing all brands of all products the customer has purchased.
most_transacted_location STRING	The store with the most transactions in the last 2 years. If no transactions have been placed in the last 2 years, this is instead a calculation of transactions for all time