get https://{host}/v2/customers/userEntityTrackers
This API enables you to retrieve tracker details of a customer in a user group.
curl --location 'http://eu.api.capillarytech.com/v2/customers/userEntityTrackers?type=USERGROUP2&identifierType=id&identifierValue=3854766&source=INSTORE%3E' \
--header 'Authorization: Basic bWFkaHzI3MjU2YQ==' \
--header 'Cookie: _cfuvid=ywN2M_QcvOeDBcXJDUKvOxjmBgRNhIajgPZwZs86g6s-1746439488628-0.0.1.1-604800000; _cfuvid=.nkd7pnYHpzU8OtgKZj_vC6yHxaPnGvgtnXKempV8Dc-1758716619391-0.0.1.1-604800000'
Parameter | Type | Description |
---|
type | string | Type of entity tracker. In this case, it is always USERGROUP2. |
identifierType | string | Type of identifier. Supported values for identifiers are id (userGroupId ), externalId , primaryUserId |
identifierValue | string | Value of the identifier. |
{
"pagination": {
"limit": 0,
"offset": 0,
"total": 0
},
"data": [
{
"id": 12446,
"name": "TransactionTotalQuantity_Tracker",
"conditionId": 638,
"type": "BILL_TOTAL_QTY",
"value": 0,
"updatedOn": "2025-04-24T15:12:51Z",
"conditionName": "TransactionQuantity_Tracker",
"periodStartDate": "2025-04-24T15:12:51Z",
"periodEndDate": "2125-04-24T23:59:59Z"
},
{
"id": 12364,
"name": "Tracker 1",
"conditionId": 635,
"type": "BILL_AMOUNT",
"value": 0,
"updatedOn": "2025-04-24T15:12:51Z",
"conditionName": "CapBigSale",
"periodStartDate": "2025-04-24T15:12:51Z",
"periodEndDate": "2125-04-24T23:59:59Z"
},
{
"id": 12445,
"name": "LineItemAmount_Tracker",
"conditionId": 637,
"type": "LINEITEM_AMOUNT",
"value": 0,
"updatedOn": "2025-04-24T15:12:51Z",
"conditionName": "LineItemAmount_Tracker",
"periodStartDate": "2025-04-24T15:12:51Z",
"periodEndDate": "2125-04-24T23:59:59Z"
}
],
"warnings": [],
"errors": []
}
Parameter | Description |
---|
pagination | Pagination details for the data. |
data | Array containing tracked entity data. |
id | Unique identifier for the tracked entity. |
name | Name of the tracked entity. |
conditionId | Identifier for the condition associated with the tracker. |
value | Value associated with the tracker. |
updatedOn | Date when the tracker was last updated, in ISO YYYY-MM-DD HH:MM:SS.s format. |
conditionName | Name of the associated condition. |
periodStartDate | Start date of the tracking period, in ISO YYYY-MM-DD HH:MM:SS.s format. |
periodEndDate | End date of the tracking period, in ISO YYYY-MM-DD HH:MM:SS.s format. |
warnings | Array containing warning messages. |
errors | Array containing error messages. |
Code | Reason | Description |
---|
1645 | group details passed are not valid. | The group details provided are invalid. |
1099 | Error fetching tracker data for customer. | The system was unable to fetch tracker data for the customer. |
1647 | Get trackers entity type not set/invalid. supported types include USERGROUP2,CUSTOMER. | The provided entity type is invalid or unsupported. |