Skip to main content
GET
/
v3
/
profiles
/
{profile}
/
aggregations
Read Aggregations
curl --request GET \
  --url http://localhost/api/v3/profiles/{profile}/aggregations
{
  "data": {
    "profile_id": "<string>",
    "shop_days": "<string>",
    "spend_12m": "<string>",
    "spend_12m_now": "<string>",
    "spend_all": "<string>",
    "spend_atv_12m": "<string>",
    "spend_atv_all": "<string>",
    "discount_avg": "<string>",
    "spend_first_date": "<string>",
    "spend_last_date": "<string>",
    "dimension_frequency": "<string>",
    "dimension_recency": "<string>",
    "dimension_join": "<string>",
    "channel": "<string>",
    "shop_count": "<string>",
    "total_referred": "<string>",
    "store_join": {
      "id": 123,
      "type": "<string>",
      "name": "<string>",
      "handle": "<string>",
      "description": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "timezone": "<string>",
      "external_id": "<string>",
      "external_code": "<string>",
      "is_published": true,
      "is_permanently_closed": true,
      "address": {
        "id": 123,
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "address_line_3": "<string>",
        "company": "<string>",
        "latitude": 123,
        "longitude": 123,
        "city": "<string>",
        "postcode": "<string>",
        "state": "<string>",
        "country": "<string>",
        "notes": "<string>",
        "external_id": "<string>",
        "is_default": true,
        "created_at": "<string>",
        "updated_at": "<string>",
        "meta": [
          "<unknown>"
        ],
        "name": "<string>",
        "type": "<string>",
        "phone": "<string>",
        "iso": "<string>",
        "iso_state": "<string>",
        "profile_id": "<string>",
        "custom_fields": {}
      },
      "normal_hours": [
        [
          "<unknown>"
        ]
      ],
      "special_hours": [
        [
          "<unknown>"
        ]
      ],
      "tags": [
        "<string>"
      ],
      "custom_fields": {},
      "icon": "<string>",
      "country_iso_3": "<string>",
      "image_url": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "departments": [
        {
          "id": 123,
          "name": "<string>",
          "handle": "<string>",
          "external_id": "<string>",
          "external_code": "<string>",
          "description": "<string>",
          "short_description": "<string>",
          "url": "<string>",
          "image_url": "<string>",
          "internal_note": "<string>",
          "meta": [
            "<unknown>"
          ],
          "brand_id": 123,
          "location_id": 123,
          "brand": {
            "name": "<string>",
            "handle": "<string>"
          },
          "created_at": "<string>",
          "updated_at": "<string>"
        }
      ]
    },
    "likely_country": "<string>",
    "likely_country_score": "<string>",
    "purchased_brands": "<string>",
    "total_shop_days": "<string>",
    "first_shop_days": "<string>",
    "second_shop_days": "<string>",
    "latest_shop_days": "<string>",
    "average_shop_days": "<string>",
    "second_shop_date": "<string>",
    "previous_shop_date": "<string>",
    "at_risk_date": "<string>",
    "most_transacted_location": {
      "id": 123,
      "type": "<string>",
      "name": "<string>",
      "handle": "<string>",
      "description": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "timezone": "<string>",
      "external_id": "<string>",
      "external_code": "<string>",
      "is_published": true,
      "is_permanently_closed": true,
      "address": {
        "id": 123,
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "address_line_3": "<string>",
        "company": "<string>",
        "latitude": 123,
        "longitude": 123,
        "city": "<string>",
        "postcode": "<string>",
        "state": "<string>",
        "country": "<string>",
        "notes": "<string>",
        "external_id": "<string>",
        "is_default": true,
        "created_at": "<string>",
        "updated_at": "<string>",
        "meta": [
          "<unknown>"
        ],
        "name": "<string>",
        "type": "<string>",
        "phone": "<string>",
        "iso": "<string>",
        "iso_state": "<string>",
        "profile_id": "<string>",
        "custom_fields": {}
      },
      "normal_hours": [
        [
          "<unknown>"
        ]
      ],
      "special_hours": [
        [
          "<unknown>"
        ]
      ],
      "tags": [
        "<string>"
      ],
      "custom_fields": {},
      "icon": "<string>",
      "country_iso_3": "<string>",
      "image_url": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "departments": [
        {
          "id": 123,
          "name": "<string>",
          "handle": "<string>",
          "external_id": "<string>",
          "external_code": "<string>",
          "description": "<string>",
          "short_description": "<string>",
          "url": "<string>",
          "image_url": "<string>",
          "internal_note": "<string>",
          "meta": [
            "<unknown>"
          ],
          "brand_id": 123,
          "location_id": 123,
          "brand": {
            "name": "<string>",
            "handle": "<string>"
          },
          "created_at": "<string>",
          "updated_at": "<string>"
        }
      ]
    },
    "most_spend_location": {
      "id": 123,
      "type": "<string>",
      "name": "<string>",
      "handle": "<string>",
      "description": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "timezone": "<string>",
      "external_id": "<string>",
      "external_code": "<string>",
      "is_published": true,
      "is_permanently_closed": true,
      "address": {
        "id": 123,
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "address_line_3": "<string>",
        "company": "<string>",
        "latitude": 123,
        "longitude": 123,
        "city": "<string>",
        "postcode": "<string>",
        "state": "<string>",
        "country": "<string>",
        "notes": "<string>",
        "external_id": "<string>",
        "is_default": true,
        "created_at": "<string>",
        "updated_at": "<string>",
        "meta": [
          "<unknown>"
        ],
        "name": "<string>",
        "type": "<string>",
        "phone": "<string>",
        "iso": "<string>",
        "iso_state": "<string>",
        "profile_id": "<string>",
        "custom_fields": {}
      },
      "normal_hours": [
        [
          "<unknown>"
        ]
      ],
      "special_hours": [
        [
          "<unknown>"
        ]
      ],
      "tags": [
        "<string>"
      ],
      "custom_fields": {},
      "icon": "<string>",
      "country_iso_3": "<string>",
      "image_url": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "departments": [
        {
          "id": 123,
          "name": "<string>",
          "handle": "<string>",
          "external_id": "<string>",
          "external_code": "<string>",
          "description": "<string>",
          "short_description": "<string>",
          "url": "<string>",
          "image_url": "<string>",
          "internal_note": "<string>",
          "meta": [
            "<unknown>"
          ],
          "brand_id": 123,
          "location_id": 123,
          "brand": {
            "name": "<string>",
            "handle": "<string>"
          },
          "created_at": "<string>",
          "updated_at": "<string>"
        }
      ]
    },
    "most_spend_12m_location": {
      "id": 123,
      "type": "<string>",
      "name": "<string>",
      "handle": "<string>",
      "description": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "timezone": "<string>",
      "external_id": "<string>",
      "external_code": "<string>",
      "is_published": true,
      "is_permanently_closed": true,
      "address": {
        "id": 123,
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "address_line_3": "<string>",
        "company": "<string>",
        "latitude": 123,
        "longitude": 123,
        "city": "<string>",
        "postcode": "<string>",
        "state": "<string>",
        "country": "<string>",
        "notes": "<string>",
        "external_id": "<string>",
        "is_default": true,
        "created_at": "<string>",
        "updated_at": "<string>",
        "meta": [
          "<unknown>"
        ],
        "name": "<string>",
        "type": "<string>",
        "phone": "<string>",
        "iso": "<string>",
        "iso_state": "<string>",
        "profile_id": "<string>",
        "custom_fields": {}
      },
      "normal_hours": [
        [
          "<unknown>"
        ]
      ],
      "special_hours": [
        [
          "<unknown>"
        ]
      ],
      "tags": [
        "<string>"
      ],
      "custom_fields": {},
      "icon": "<string>",
      "country_iso_3": "<string>",
      "image_url": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "departments": [
        {
          "id": 123,
          "name": "<string>",
          "handle": "<string>",
          "external_id": "<string>",
          "external_code": "<string>",
          "description": "<string>",
          "short_description": "<string>",
          "url": "<string>",
          "image_url": "<string>",
          "internal_note": "<string>",
          "meta": [
            "<unknown>"
          ],
          "brand_id": 123,
          "location_id": 123,
          "brand": {
            "name": "<string>",
            "handle": "<string>"
          },
          "created_at": "<string>",
          "updated_at": "<string>"
        }
      ]
    },
    "latest_shop_spend": "<string>",
    "latest_shop_currency": {
      "id": 123,
      "from": "<string>",
      "to": "<string>",
      "rate": 123,
      "is_system": true,
      "created_at": "<string>",
      "updated_at": "<string>"
    },
    "latest_transacted_location": {
      "id": 123,
      "type": "<string>",
      "name": "<string>",
      "handle": "<string>",
      "description": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "timezone": "<string>",
      "external_id": "<string>",
      "external_code": "<string>",
      "is_published": true,
      "is_permanently_closed": true,
      "address": {
        "id": 123,
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "address_line_3": "<string>",
        "company": "<string>",
        "latitude": 123,
        "longitude": 123,
        "city": "<string>",
        "postcode": "<string>",
        "state": "<string>",
        "country": "<string>",
        "notes": "<string>",
        "external_id": "<string>",
        "is_default": true,
        "created_at": "<string>",
        "updated_at": "<string>",
        "meta": [
          "<unknown>"
        ],
        "name": "<string>",
        "type": "<string>",
        "phone": "<string>",
        "iso": "<string>",
        "iso_state": "<string>",
        "profile_id": "<string>",
        "custom_fields": {}
      },
      "normal_hours": [
        [
          "<unknown>"
        ]
      ],
      "special_hours": [
        [
          "<unknown>"
        ]
      ],
      "tags": [
        "<string>"
      ],
      "custom_fields": {},
      "icon": "<string>",
      "country_iso_3": "<string>",
      "image_url": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "departments": [
        {
          "id": 123,
          "name": "<string>",
          "handle": "<string>",
          "external_id": "<string>",
          "external_code": "<string>",
          "description": "<string>",
          "short_description": "<string>",
          "url": "<string>",
          "image_url": "<string>",
          "internal_note": "<string>",
          "meta": [
            "<unknown>"
          ],
          "brand_id": 123,
          "location_id": 123,
          "brand": {
            "name": "<string>",
            "handle": "<string>"
          },
          "created_at": "<string>",
          "updated_at": "<string>"
        }
      ]
    },
    "transacted_locations": "<string>",
    "likely_country_iso": "<string>",
    "likely_country_iso_score": "<string>",
    "likely_state_iso": "<string>",
    "likely_state_iso_score": "<string>",
    "likely_region": "<string>",
    "likely_region_score": "<string>",
    "top_historic_status": {
      "id": "<string>",
      "name": "<string>",
      "handle": "<string>",
      "sort_order": "<string>",
      "description": "<string>",
      "short_description": "<string>",
      "long_description": "<string>",
      "terms_conditions": "<string>",
      "icon": "<string>",
      "image_url": "<string>",
      "earn_instructions": "<string>",
      "colour": "<string>",
      "primary_colour": "<string>",
      "secondary_colour": "<string>",
      "text_colour": "<string>",
      "code": "<string>",
      "internal_notes": "<string>",
      "group_name": "<string>",
      "group_handle": "<string>",
      "timezone": "<string>",
      "period": "<string>",
      "period_type": "<string>",
      "absolute_expiry": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

{
  "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 calculationsAggregations are automatically recalculated with every transaction made against the profile. All calculations against a profile are refreshed at once.

Aggregation Properties

AttributeDescription
profile_id READ_ONLYThe profile_id of the profile the aggregation belongs to
shop_days INTEGERAverage days between shops this represents the average of days between the customers purchases.
spend_12m FLOATThe total dollar value spent over 12 months from the last recalculation date.
spend_all FLOATThe total dollar value spent since the profile was created
spend_atv_12m FLOATThe average transaction value over 12 months from the last recalculation date
spend_atv_all FLOATThe average transaction value since the profile was created
spend_first_date DATE-TIMERecords the date of the Profiles first transaction converted to UTC timezone.
spend_last_date DATE-TIMERecords the last date of the Profiles transacted converted to UTC timezone.
dimension_frequency STRINGA 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 STRINGA 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 STRINGA 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 STRINGA 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 INTEGERThe count of total profile transactions, with transactions greater than $0
store_join STRINGthe store of the profiles first transaction. This is the first store the profile shopped at
likely_country STRINGThe 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 INTEGERThis is a numerical score given to the strength of the prediction. with 1 being the highest
purchased_brands ARRAYAn array representing all brands of all products the customer has purchased.
most_transacted_location STRINGThe 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

Path Parameters

profile
string<uuid>
required

The profile ID

Response

ProfileAggregation

data
ProfileAggregation · object
required