post https://{host}/targetGroups
This API is used to create target groups.
Target groups are essentially the entities within which individual targets can be created. Meaning, to create targets, first target group should be created, and that can be achieved with this API.
Note
For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .
Prerequisites
- Authentication: Basic/OAuth authentication
- Default access group
Resource information
| URI | v3/targetGroups |
| HTTP method | POST |
| Pagination | NA |
| Rate limit | NA |
| Batch support | NA |
API endpoint example
https://eucrm.cc.capillarytech.com/v3/targetGroups
Request body parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| active | Boolean | Indicates if the tracking is active or not. |
| description | String | A brief description of the target group. |
| name | String | The name identifier for the target group. |
| preferredTillId | Number | Identifier for a preferred till. |
| trackingType | String | The type of tracking the milestone is created for. Supported values: Default (single target tracking), Unified (tracking multiple targets as a unit), Streak (Tracking the achievement of a user across the cycles continuously), Capping (Tracking the number of points a user has got over a period, so that capping can be applied). Non |
| targetEvaluationType | String | The evaluation strategy for the targets. Supported values: FIXED_CALENDAR_WINDOW, CYCLIC_WINDOW, PERIOD_AGNOSTIC_WINDOW |
| totalPeriods | Number | The total number of periods over which the tracking is evaluated. |
| frequencyType | Enum | The frequency of each cycle in which the user has to achieve the target value. Supported values: Montly, Quarterly, Half-yearly, Yearly, Weekly. |
| frequency | Number | The frequency count, relevant to the frequencyType. |
| recurringCycles | Number | The number of cycles for which the tracking recurs. |
| periods | Object | An array of period objects, each containing details about the individual periods within the tracking. |
| active | Boolean | Indicates if the period is active. |
| description | String | A brief description of the period. |
| endDate | Date Time | The end date and time of the period. |
| periodStatus | String | Indicates if the cycle of the Milestone is active/inactive. |
| refCode | String | A reference code for the period. |
| startDate | Date Time | The start date and time of the period. |
| targets | Object | An array of target objects, each outlining a target within the tracking. |
| active | Boolean | Indicates if the target is active. |
| description | String | A brief description of the target. |
| expression | String | A string representing the condition to meet the target. |
| expressionJson | String | A JSON expression that specifies the conditions required to achieve the target. |
| filters | Object | An array of filters applied to the target. |
| entityType | Enum | The type of entity to which the filter applies (e.g., STORE). |
| entityIds | Array | The IDs of the entities to which the filter applies. |
| name | String | The name identifier for the target. |
| targetEntity | Enum | The KPI on which the target is tracked. For the transactional KPIs, the supported value for this are Transaction and Lineitem. For the Behavioural or EMF events, the supported value is EVENT. For the tracking based on rewards such as points, the supported value will be REWARDS. |
| eventName | String | The behavioral name of the event that triggers the target. |
| targetType | Enum | Target type on which the target is set. Supported values: QUANTITY, SALES, COUNT, VISIT, GROSS_SALES, REGULAR_POINTS, PROMOTIONAL_POINTS, ALL_POINTS, EXTENDED_FIELD, and EVENT_ATTRIBUTE For information based on configuring target based on behavioural event (COUNT, VISIT, and SUM [EVENT_ATTRIBUTE]) and EMF event (COUNT and VISIT), refer to target based on behavioural event and target based on EMF event documentation. |
| extendedFieldInfo | Object | Includes the details of the event attribute that needs to be tracked. |
| name | String | Behavioral event attribute name. For example, cartId. |
| aggregateFunction | Enum | Supported values: SUM and COUNT For example: To track the number of "addtocart" events, monitor the event along with its 'cartId' attribute. Set "aggregateFunction" to COUNT to tally these events and see if your goal is met. Similarly, for tracking total cart value, use SUM as your "aggregateFunction" with a related event to sum up the value and check against your target. |
| defaultValues | Object | An array of objects providing default values related to the target. |
| defaultValue | Integer | A default value used in the target evaluation. |
| streaks | Object | An array of streak information. |
| name | String | Name of the streak. |
| targetCountOfSequence | Integer | Number of the times the user has to achieve the target to redeem the reward. |
{
"active": true,
"description": "Madridsta 22",
"name": "Madridstaloyalty0211",
"preferredTillId": 0,
"trackingType": "DEFAULT",
"targetEvaluationType": "FIXED_CALENDAR_WINDOW",
"totalPeriods": 2,
"frequencyType": "DAILY",
"frequency": 0,
"recurringCycles": 0,
"periods": [
{
"active": true,
"description": "pt10",
"endDate": "2024-04-06T23:59:59.999",
"periodStatus": "RUNNING",
"refCode": "Madridstaloyalty022p10",
"startDate": "2024-04-06T00:00:00.000"
},
{
"active": true,
"description": "pt11",
"endDate": "2024-04-07T23:59:59.999",
"periodStatus": "RUNNING",
"refCode": "Madridstaloyalty022p11",
"startDate": "2024-04-07T00:00:00.000"
}
],
"targets": [
{
"active": true,
"description": "loyalty",
"expression": "currentTxn.value>500",
"expressionJson": "{\"arity\":\"binary_operation\",\"value\":\">\",\"type\":\"boolean:primitive\",\"operands\":[{\"arity\":\"object_dereference\",\"type\":\"real:object:primitive\",\"operands\":[{\"arity\":\"name\",\"value\":\"currentTxn\",\"type\":\"tx:object:primitive\"},{\"arity\":\"name\",\"value\":\"value\",\"type\":\"real:object:primitive\"}]},{\"arity\":\"literal\",\"value\":\"500\",\"type\":\"number:primitive\"}]}",
"filters": [
{
"entityType": "STORE",
"entityIds": [
50678045
]
}
],
"name": "Madridstaloyalty022TXN50011",
"targetEntity": "EVENT",
"eventName": "removedFromCart",
"targetType": "EVENT_ATTRIBUTE",
"extendedFieldInfo": {
"name": "cartId",
"aggregateFunction": "SUM"
},
"defaultValues": [
{
"defaultValue": 500
},
{
"defaultValue": 500
}
]
},
{
"active": true,
"description": "loyalty",
"expression": "currentTxn.value>5000",
"expressionJson": "{\"arity\":\"binary_operation\",\"value\":\">\",\"type\":\"boolean:primitive\",\"operands\":[{\"arity\":\"object_dereference\",\"type\":\"real:object:primitive\",\"operands\":[{\"arity\":\"name\",\"value\":\"currentTxn\",\"type\":\"tx:object:primitive\"},{\"arity\":\"name\",\"value\":\"value\",\"type\":\"real:object:primitive\"}]},{\"arity\":\"literal\",\"value\":\"500\",\"type\":\"number:primitive\"}]}",
"filters": [
{
"entityType": "STORE",
"entityIds": [
50678045
]
}
],
"name": "Madridstaloyaltystreak022TXN500011",
"targetEntity": "EVENT",
"eventName": "appInstalled",
"targetType": "EVENT_ATTRIBUTE",
"extendedFieldInfo": {
"name": "deviceId",
"aggregateFunction": "SUM"
},
"defaultValues": [
{
"defaultValue": 500
},
{
"defaultValue": 500
}
]
}
]
}
{
"active": true,
"description": "streak group",
"name": "streakTestt123",
"preferredTillId": 0,
"trackingType": "STREAKS",
"targetEvaluationType": "FIXED_CALENDAR_WINDOW",
"totalPeriods": 1,
"frequencyType": "CUSTOM",
"periods": [
{
"active": true,
"description": "p1",
"endDate": "2023-11-17T23:45:12.063",
"periodStatus": "RUNNING",
"refCode": "period44",
"startDate": "2023-11-17T00:45:12.063"
},
{
"active": true,
"description": "p1",
"endDate": "2023-11-20T23:45:12.063",
"periodStatus": "RUNNING",
"refCode": "period45",
"startDate": "2023-11-18T00:45:12.063"
}
],
"targets": [
{
"active": true,
"description": "streak",
"expression": "currentTxn.value>500",
"expressionJson": "{\"arity\":\"binary_operation\",\"value\":\">\",\"type\":\"boolean:primitive\",\"operands\":[{\"arity\":\"object_dereference\",\"type\":\"real:object:primitive\",\"operands\":[{\"arity\":\"name\",\"value\":\"currentTxn\",\"type\":\"tx:object:primitive\"},{\"arity\":\"name\",\"value\":\"value\",\"type\":\"real:object:primitive\"}]},{\"arity\":\"literal\",\"value\":\"500\",\"type\":\"number:primitive\"}]}",
"filters": [
{
"entityType": "STORE",
"entityIds": [
50679757,
50679770
]
}
],
"name": "streakTestt123",
"targetEntity": "TRANSACTION",
"enrolmentMethod": "TRANSACTION",
"targetType": "SALES",
"defaultValues": [
{
"defaultValue": 500
},
{
"defaultValue": 1000
}
]
}
],
"streaks": [
{
"name": "streakTestt193",
"targetCountOfSequence": 1
},
{
"name": "streakTestt123",
"targetCountOfSequence": 2
}
]
}
Response parameters
| Field | Datatype | Description |
|---|---|---|
| id | integer | Unique identifier for the setting/group. |
| name | string | Name of the setting/group. |
| active | boolean | Indicates if the setting/group is active. |
| preferredTillId | integer | Preferred till ID, indicating no specific preference with 0. |
| totalPeriods | integer | Total number of periods specified. |
| description | string | Description of the setting/group. |
| targetEvaluationType | string | Type of target evaluation, e.g., "FIXED_CALENDAR_WINDOW". |
| targetCycleStartDate | string (date-time) | Start date and time for the target cycle. |
| targetCycleEndDate | string (date-time) | End date and time for the target cycle (if applicable). |
| frequencyType | string | Frequency type, e.g., "CUSTOM" (if applicable). |
| trackingType | string | Type of tracking, e.g., "STREAKS" (if applicable). |
| fromDate | string (date) | Start date for the setting (if applicable). |
| toDate | string (date) | End date for the setting (if applicable). |
| recurringCycles | integer | Number of recurring cycles specified (if applicable). |
| frequency | integer | Frequency value set for the setting (if applicable). |
| id | integer | Unique identifier for each period. |
| startDate | string (date) | Start date for each period. |
| endDate | string (date) | End date for each period. |
| refCode | string | Reference code for each period. |
| periodStatus | string | Status of each period, e.g., "RUNNING", "NOT_STARTED". |
| targetGroupId | integer | Identifier linking each period to a target group. |
| description | string | Description of each period. |
| active | boolean | Indicates if each period is active. |
| id | integer | Unique identifier for each streak. |
| name | string | Name of each streak. |
| targetCountOfSequence | integer | Target count of sequence for each streak. |
| id | integer | Unique identifier for each target. |
| name | string | Name of each target. |
| targetType | string | Type of each target, e.g., "SALES". |
| targetEntity | string | Type of entity targeted by each target, e.g., "TRANSACTION". |
| eventName | string | Name of the event associated with each target. |
| description | string | Description of each target. |
| active | boolean | Indicates if each target is active. |
| expression | string | Expression defining the criteria for each target. |
| expressionJson | string (JSON) | Target expression in JSON format for each target. |
| entityType | string | Type of entity for the filter of each target, e.g., "STORE". |
| entityIds | array of integers | IDs of entities for the filter of each target. |
| enrolmentMethod | string | Method of enrolment for each target, e.g., "TRANSACTION". |
| defaultValue | float | Specifies a default value for the target criteria for each target. |
{
"data": {
"id": 32,
"name": "TGF19",
"fromDate": "2021-05-27",
"toDate": "2021-05-28",
"active": true,
"preferredTillId": 0,
"periods": [
{
"id": 74,
"attribution": {
"createdOn": "2022-03-28T13:28:32.602+0000",
"lastUpdatedOn": "2022-03-28T13:28:32.602+0000",
"lastUpdatedBy": {
"id": 75040399,
"code": "bukl.till",
"description": "",
"name": "bukl.till",
"type": "TILL"
},
"createdBy": {
"id": 75040399,
"code": "bukl.till",
"description": "",
"name": "bukl.till",
"type": "TILL"
}
},
"startDate": "2022-03-29",
"endDate": "2022-05-29",
"refCode": "string",
"periodStatus": "NOT_STARTED",
"targetGroupId": 32,
"description": "string",
"active": true
}
],
"activePeriod": {
"startDate": "2022-03-28",
"endDate": "2022-04-29",
"refCode": "gdf123",
"periodStatus": "RUNNING",
"description": "Samplr description",
"active": true
},
"totalPeriods": 0,
"description": "TGF19",
"recurringCycles": 2,
"frequency": 5,
"targetCycleStartDate": "2021-05-28T08:41:00.529Z"
},
"errors": null
}
{
"data": {
"id": 9919,
"name": "streakTestt123",
"active": true,
"preferredTillId": 0,
"periods": [
{
"id": 10678,
"attribution": {
"createdOn": "2023-11-17T07:04:44.000+0000",
"lastUpdatedOn": "2023-11-17T07:04:44.000+0000",
"lastUpdatedBy": {
"id": 50129465,
"code": "till_store1",
"description": "",
"name": "till_store1",
"type": "TILL"
},
"createdBy": {
"id": 50129465,
"code": "till_store1",
"description": "",
"name": "till_store1",
"type": "TILL"
}
},
"startDate": "2023-11-17",
"endDate": "2023-11-17",
"refCode": "period44",
"periodStatus": "RUNNING",
"targetGroupId": 9919,
"description": "p1",
"active": true
},
{
"id": 10679,
"attribution": {
"createdOn": "2023-11-17T07:04:44.000+0000",
"lastUpdatedOn": "2023-11-17T07:04:44.000+0000",
"lastUpdatedBy": {
"id": 50129465,
"code": "till_store1",
"description": "",
"name": "till_store1",
"type": "TILL"
},
"createdBy": {
"id": 50129465,
"code": "till_store1",
"description": "",
"name": "till_store1",
"type": "TILL"
}
},
"startDate": "2023-11-18",
"endDate": "2023-11-20",
"refCode": "period45",
"periodStatus": "NOT_STARTED",
"targetGroupId": 9919,
"description": "p1",
"active": true
}
],
"streaks": [
{
"id": 9,
"attribution": {
"createdOn": "2023-11-17T07:04:44.483+0000",
"lastUpdatedOn": "2023-11-17T07:04:44.483+0000",
"lastUpdatedBy": {
"id": 50129465,
"code": "till_store1",
"description": "",
"name": "till_store1",
"type": "TILL"
},
"createdBy": {
"id": 50129465,
"code": "till_store1",
"description": "",
"name": "till_store1",
"type": "TILL"
}
},
"targetGroupId": 9919,
"name": "streakTestt193",
"targetCountOfSequence": 1
},
{
"id": 10,
"attribution": {
"createdOn": "2023-11-17T07:04:44.483+0000",
"lastUpdatedOn": "2023-11-17T07:04:44.483+0000",
"lastUpdatedBy": {
"id": 50129465,
"code": "till_store1",
"description": "",
"name": "till_store1",
"type": "TILL"
},
"createdBy": {
"id": 50129465,
"code": "till_store1",
"description": "",
"name": "till_store1",
"type": "TILL"
}
},
"targetGroupId": 9919,
"name": "streakTestt123",
"targetCountOfSequence": 2
}
],
"totalPeriods": 1,
"description": "streak group",
"targetEvaluationType": "FIXED_CALENDAR_WINDOW",
"targetCycleStartDate": "2023-11-17T00:00:00.000Z",
"targetCycleEndDate": "2023-11-20T23:59:59.000Z",
"frequencyType": "CUSTOM",
"trackingType": "STREAKS",
"targets": [
{
"id": 22030,
"attribution": {
"createdOn": "2023-11-17T07:04:44.612+0000",
"lastUpdatedOn": "2023-11-17T07:04:44.612+0000",
"lastUpdatedBy": {
"id": 50129465,
"code": "till_store1",
"description": "",
"name": "till_store1",
"type": "TILL"
},
"createdBy": {
"id": 50129465,
"code": "till_store1",
"description": "",
"name": "till_store1",
"type": "TILL"
}
},
"name": "streakTestt123",
"emfRuleSetId": 1200627,
"targetType": "SALES",
"targetEntity": "TRANSACTION",
"eventName": "TransactionAdd",
"targetGroupId": 9919,
"description": "streak",
"active": true,
"expression": "currentTxn.value>500",
"expressionJson": "{\"arity\":\"binary_operation\",\"value\":\">\",\"type\":\"boolean:primitive\",\"operands\":[{\"arity\":\"object_dereference\",\"type\":\"real:object:primitive\",\"operands\":[{\"arity\":\"name\",\"value\":\"currentTxn\",\"type\":\"tx:object:primitive\"},{\"arity\":\"name\",\"value\":\"value\",\"type\":\"real:object:primitive\"}]},{\"arity\":\"literal\",\"value\":\"500\",\"type\":\"number:primitive\"}]}",
"filters": [
{
"entityType": "STORE",
"entityIds": [
50679757,
50679770
]
}
],
"enrolmentMethod": "TRANSACTION",
"defaultValues": [
{
"id": 24105,
"periodId": 10678,
"defaultValue": 500.000
},
{
"id": 24106,
"periodId": 10679,
"defaultValue": 1000.000
}
]
},
{
"id": 22031,
"attribution": {
"createdOn": "2023-11-17T07:04:44.789+0000",
"lastUpdatedOn": "2023-11-17T07:04:44.789+0000",
"lastUpdatedBy": {
"id": 50129465,
"code": "till_store1",
"description": "",
"name": "till_store1",
"type": "TILL"
},
"createdBy": {
"id": 50129465,
"code": "till_store1",
"description": "",
"name": "till_store1",
"type": "TILL"
}
},
"name": "streakTestt123_ReturnBill",
"emfRuleSetId": 1200628,
"targetType": "SALES",
"targetEntity": "TRANSACTION",
"eventName": "ReturnBill",
"targetGroupId": 9919,
"description": "streak",
"active": true,
"expression": "currentTxn.value>500",
"expressionJson": "{\"arity\":\"binary_operation\",\"value\":\">\",\"type\":\"boolean:primitive\",\"operands\":[{\"arity\":\"object_dereference\",\"type\":\"real:object:primitive\",\"operands\":[{\"arity\":\"name\",\"value\":\"currentTxn\",\"type\":\"tx:object:primitive\"},{\"arity\":\"name\",\"value\":\"value\",\"type\":\"real:object:primitive\"}]},{\"arity\":\"literal\",\"value\":\"500\",\"type\":\"number:primitive\"}]}",
"filters": [
{
"entityType": "STORE",
"entityIds": [
50679757,
50679770
]
}
],
"enrolmentMethod": "TRANSACTION",
"defaultValues": [
{
"id": 24107,
"periodId": 10678,
"defaultValue": 500.000
},
{
"id": 24108,
"periodId": 10679,
"defaultValue": 1000.000
}
]
}
]
},
"errors": null,
"warnings": null
}