Skip to main content
PUT
/
v3
/
profiles
/
{profile}
/
aggregations
Edit Profile Aggregation
curl --request PUT \
  --url http://localhost/api/v3/profiles/{profile}/aggregations \
  --header 'Content-Type: application/json' \
  --data '
{
  "shop_days": 123,
  "shop_count": 123,
  "spend_12m": 123,
  "spend_12m_now": 123,
  "spend_all": 123,
  "spend_atv_12m": 123,
  "spend_atv_all": 123,
  "spend_first_date": "2023-11-07T05:31:56Z",
  "spend_last_date": "2023-11-07T05:31:56Z",
  "dimension_frequency": "<string>",
  "dimension_recency": "<string>",
  "dimension_join": "<string>",
  "channel": "<string>",
  "likely_country": "<string>",
  "likely_country_score": 123,
  "purchased_brands": [
    "<string>"
  ],
  "discount_avg": 123,
  "total_shop_days": 123,
  "first_shop_days": 123,
  "second_shop_days": 123,
  "latest_shop_days": 123,
  "average_shop_days": 123,
  "second_shop_date": "2023-11-07T05:31:56Z",
  "previous_shop_date": "2023-11-07T05:31:56Z",
  "at_risk_date": "2023-11-07T05:31:56Z",
  "latest_shop_spend": 123,
  "latest_shop_currency_id": 123,
  "latest_transacted_location_id": 123,
  "transacted_locations": [
    "<string>"
  ],
  "likely_country_iso": "<string>",
  "likely_country_iso_score": 123,
  "likely_state_iso": "<string>",
  "likely_state_iso_score": 123,
  "likely_region": "<string>",
  "likely_region_score": 123,
  "most_spend_location_id": 123,
  "most_spend_12m_location_id": 123,
  "top_historic_status_id": 123
}
'
{
  "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.

Path Parameters

​
profile
string<uuid>
required

The profile ID

Body

application/json
​
shop_days
integer | null
​
shop_count
integer | null
​
spend_12m
number | null
​
spend_12m_now
number | null
​
spend_all
number | null
​
spend_atv_12m
number | null
​
spend_atv_all
number | null
​
spend_first_date
string<date-time> | null
​
spend_last_date
string<date-time> | null
​
dimension_frequency
string | null
​
dimension_recency
string | null
​
dimension_join
string | null
​
channel
string | null
​
likely_country
string | null
​
likely_country_score
number | null
​
purchased_brands
string[] | null
​
discount_avg
number | null
​
total_shop_days
integer | null
​
first_shop_days
integer | null
​
second_shop_days
integer | null
​
latest_shop_days
integer | null
​
average_shop_days
number | null
​
second_shop_date
string<date-time> | null
​
previous_shop_date
string<date-time> | null
​
at_risk_date
string<date-time> | null
​
latest_shop_spend
number | null
​
latest_shop_currency_id
integer | null
​
latest_transacted_location_id
integer | null
​
transacted_locations
string[] | null
​
likely_country_iso
string | null
​
likely_country_iso_score
number | null
​
likely_state_iso
string | null
​
likely_state_iso_score
number | null
​
likely_region
string | null
​
likely_region_score
number | null
​
most_spend_location_id
integer | null
​
most_spend_12m_location_id
integer | null
​
top_historic_status_id
integer | null

Response

ProfileAggregation

​
data
ProfileAggregation · object
required