Time	Status	User Agent
Retrieving recent requests…

❗️
This API is being phased out and will no longer be available for creating new milestones.
To create a new milestone, use the Create a Loyalty Promotion API

Behavioral Events Target Group API

Behavioral events track specific user actions (e.g., profile updates, reviews, step counts). Brands reward users upon achieving milestones based on these events.

Behavioral events are a way using which brands track the behavioral properties of their customers. For example:

Whether a user has updated the profile picture?
Whether a user has provided the product review?
Whether a user has walked 5000 steps?

Using the milestones, brands can track these behavioral events and reward their users. For example:

Give 100 points to the user for updating the profile picture 2 times a month.
Give a $1 coupon to the user for giving 3 product reviews in a quarter.
Give a fitness badge to the user for walking 5000 steps in 2 days.

📘
Note
Unlike targets such as QUANTITY, SALES, GROSS_SALES, REGULAR_POINTS, PROMOTIONAL_POINTS,
ALL_POINTS, EXTENDED_FIELD, where the user has to make 3 API calls (target-group, period, and target) to create a single target, the behavioural type of targets can be created using a single call by placing the entire information in the single call itself. It means the definition of all the keys will be the same except for the following:

targetEntity = "Event".
eventName = "name of the behavioral event".
1. This key will be present in the request body for the behavioural event type of targets.

targetType = "COUNT"/"VISIT"/"EVENT_ATTRIBUTE". Only these 3 are supported.

When the targetType is given as "EVENT_ATTRIBUTE", then:

An "extendedFieldInfo object is applicable that contains 2 parameters:

aggregateFunction: "SUM"
name: Name of the attribute of the behavioral event on which SUM needs to happen.

"targetEntity": "EVENT",
"eventName": "removedFromCart",
"targetType": "EVENT_ATTRIBUTE",
"extendedFieldInfo": {
    "name": "cartId",
    "aggregateFunction": "SUM"}

"targetEntity": "EVENT",
"eventName": "removedFromCart",
"targetType": "COUNT"/"VISIT",
"extendedFieldInfo": {
    "name": "cartId",
    "aggregateFunction": "SUM"}

👍
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 .

API endpoint example

Using create target group: https://eu.api.capillarytech.com/v3/targetGroups

Request Body Example

curl -L 'https://eu.api.capillarytech.com/v3/targetGroups' \
-H 'Content-Type: application/json' \
-H 'Cookie: _cfuvid=aidEostKQWmdskBHmh1pchvz2wSoA1O27JghNUFOpHw-1728306311172-0.0.1.1-604800000; _cfuvid=2ieM2eqBqFdNAAdfQMYR0zNvTd6WWmQxVVyU.OyFiEw-1728475108732-0.0.1.1-604800000' \
-H 'Authorization: Basic Dc1NWE3NQ==' \
-d '{
    "active": true,
    "name": "uatTargetGroupBE02",
    "preferredTillId": 75155297,
    "fromDate": "2026-01-01T10:30:00Z",
    "toDate": "2026-01-01T10:30:00Z",
    "targetCycleStartDateISO": "2026-01-01T10:30:00+05:30",
    "targetCycleEndDateISO": "2026-02-01T10:30:00+05:30",
    "trackingType": "DEFAULT",
    "totalPeriods": 2,
    "frequency": 1,
    "recurringCycles": 1,
    "targetEvaluationType": "FIXED_CALENDAR_WINDOW",
    "targetCycleStartDate": "2025-07-17T00:00:00.529Z",
    "periods": [
        {
            "active": true,
            "description": "p1",
            "endDate": "2025-07-18T23:00:00.529Z",
            "periodStatus": "RUNNING",
            "refCode": "Cycle_1",
            "startDate": "2025-07-17T00:00:00.529Z"
        },
        {
            "active": true,
            "description": "p2",
            "endDate": "2025-07-20T00:00:00.529Z",
            "periodStatus": "NOT_STARTED",
            "refCode": "Cycle_2",
            "startDate": "2025-07-19T00:00:00.529Z"
        }
    ],
    "targets": [
        {
            "targetEntity": "EVENT",
            "targetType": "EVENT_ATTRIBUTE",
            "eventName": "TestingEvent_FE",
            "extendedFieldInfo": {
                "name": "Customer",
                "aggregateFunction": "SUM"
            },
            "defaultValues": [
                {
                    "defaultValue": 2
                },
                {
                    "defaultValue": 3
                }
            ],
            "targetMilestoneTriggers": [],
            "expression": "true",
            "expressionJson": "{\"arity\":\"literal\",\"value\":\"true\",\"type\":\"boolean:primitive\"}",
            "filters": [],
            "name": "uat_target_group_be_02",
            "enrolmentMethod": "TRANSACTION"
        }
    ]
}'

curl -L 'https://eu.api.capillarytech.com/v3/targetGroups' \
-H 'Content-Type: application/json' \
-H 'Cookie: _cfuvid=aidEostKQWmdskBHmh1pchvz2wSoA1O27JghNUFOpHw-1728306311172-0.0.1.1-604800000; _cfuvid=2ieM2eqBqFdNAAdfQMYR0zNvTd6WWmQxVVyU.OyFiEw-1728475108732-0.0.1.1-604800000' \
-H 'Authorization: Basic MmM1ZDc1NWE3NQ==' \
-d '{
    "active": true,
    "name": "uatTargetGroupBE01",
    "preferredTillId": 75155297,
    "fromDate": "2026-01-01T10:30:00Z",
    "toDate": "2026-01-01T10:30:00Z",
    "targetCycleStartDateISO": "2026-01-01T10:30:00+05:30",
    "targetCycleEndDateISO": "2026-02-01T10:30:00+05:30",
    "trackingType": "DEFAULT",
    "totalPeriods": 2,
    "frequency": 1,
    "recurringCycles": 1,
    "targetEvaluationType": "FIXED_CALENDAR_WINDOW",
    "targetCycleStartDate": "2025-07-17T00:00:00.529Z",
    "periods": [
        {
            "active": true,
            "description": "p1",
            "endDate": "2025-07-18T23:00:00.529Z",
            "periodStatus": "RUNNING",
            "refCode": "Cycle_1",
            "startDate": "2025-07-17T00:00:00.529Z"
        },
        {
            "active": true,
            "description": "p2",
            "endDate": "2025-07-20T00:00:00.529Z",
            "periodStatus": "NOT_STARTED",
            "refCode": "Cycle_2",
            "startDate": "2025-07-19T00:00:00.529Z"
        }
    ],
    "targets": [
        {
            "targetEntity": "EVENT",
            "targetType": "COUNT",
            "eventName": "TestingEvent_FE",
            "extendedFieldInfo": {
                "name": "price",
                "aggregateFunction": "SUM"
            },
            "defaultValues": [
                {
                    "defaultValue": 2
                },
                {
                    "defaultValue": 3
                }
            ],
            "targetMilestoneTriggers": [],
            "expression": "true",
            "expressionJson": "{\"arity\":\"literal\",\"value\":\"true\",\"type\":\"boolean:primitive\"}",
            "filters": [],
            "name": "uat_target_group_be_01",
            "enrolmentMethod": "TRANSACTION"
        }
    ]
}'

Prerequisites

Authentication: Basic/OAuth authentication
Default access group

Resource information


URI	v3/targetGroups
HTTP method	POST
Pagination	NA
Rate limit	NA
Batch support	NA

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. The character limit for the name is 200 characters.
preferredTillId	Number	Identifier for a preferred till.
trackingType	Enum	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 continuous streak (Non-continuous streaks is a variation of streak, where the user is not required to perform specified activity continously).
targetEvaluationType	Enum	The evaluation strategy for the targets. Supported values: FIXED_CALENDAR_WINDOW - Each cycle runs for a defined period from the selected start date. CYCLIC_WINDOW - Cycle starts after customer's 1st transaction post enrolment. PERIOD_AGNOSTIC_WINDOW - The cycle continues until the user achieves the specified target.
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: Monthly, Quarterly, Half-yearly, Yearly, Weekly, Daily, CUSTOM.
frequency	Number	The frequency count, relevant to the frequencyType.
targetCycleStartDateISO	String	Defines the target’s start date in ISO 8601 format with the region offset. For example: The start date is at 14:30:45 on December 16, 2025, in India Format for the request parameter: 2025-12-16T14:30:45+05:30
targetCycleEndDateISO	String	Defines the target’s end date in ISO 8601 format with the region offset. For example: The start date is at 14:30:45 on December 16, 2025, in India Format for the request parameter: 2025-12-16T14:30:45+05:30
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	Enum	Indicates if the cycle of the Milestone is running or upcoming. Supported values: RUNNING, UPCOMING, NOT_STARTED.
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.
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 aka rule.
expressionJson	String	A JSON expression that specifies the conditions required to achieve the target.
defaultValues	Object	An array of objects providing default values related to the target.
defaultValue	String	The default value for the target
filters	Object	In this object, you can define the entity to which the specified expressions related to the target will be applied.
enrolmentMethod	Enum	The method of enrolment for the target. Supported values: TRANSACTION, IMPORT
entityType	Enum	The entity to which the specified expressions related to the target will be applied. For example: The user has to make a purchase of shoes from ABC store. Here, purchase of shoes is the expression and the entity is ABC store. Supported values: STORE, ZONE, CONCEPT.
entityIds	Array	The IDs of the entities to which the is filter applied on.
name	String	The name identifier for the target.
targetEntity	Enum	The KPI on which the target is tracked. Supported values: TRANSACTION, LINEITEM, EVENT, REWARDS. To track the transactional KPIs, use TRANSACTION and LINEITEM . To track the Behavioural events & EMF events, use EVENT. To track the tracking based on rewards such as points, use REWARDS.
eventName	String	The behavioral name of the event that triggers the target. Only valid in the case of behavioral events & EMF events.
targetType*	Enum	The type of target. Supported values: SUM, VISIT, and COUNT (These are only 3 supported for behavioral event type of targets) To use SUM, set the value as EVENT_ATTRIBUTE and then define the details in the extendedFieldInfo object.
extendedFieldInfo	Object	Includes the details of the event attribute that needs to be tracked. This object is applicable only when targetType is SUM.
name	String	Event on which the sum calculation is performed. For example, the number of adding to cart events.
aggregateFunction	Enum	The aggregate function checks whether the behavioral event is satisfied based on the sum. Supported values: SUM
defaultValues	Object	An array of objects providing default values related to the target.
defaultValue	Integer	A default value used in the target evaluation.

Request body parameters (that are related to target)

Parameter	Data Type	Description
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	JSON	A JSON expression that specifies the conditions required to achieve the target.
filters	Array	In this object, you can define the entity to which the specified expressions related to the target will be applied.
- entityIds	Array	The IDs of the entities to which the is filter applied on.
- entityType	Enum	The entity to which the specified expressions related to the target will be applied. For example: The user has to make a purchase of shoes from ABC store. Here, purchase of shoes is the expression and the entity is ABC store. Supported values: STORE, ZONE, CONCEPT.
name*	String	Name assigned to the target.
targetEntity	Enum	The KPI on which the target is tracked. Supported values: TRANSACTION, LINEITEM, EVENT, REWARDS. To track the transactional KPIs, use TRANSACTION and LINEITEM . To track the Behavioural events, use EVENT. To track the tracking based on rewards such as points, use REWARDS.
enrolmentMethod	Enum	The method of enrolment for the target. Supported values: TRANSACTION, IMPORT
targetGroupId*	Integer	ID of the target group.
targetType*	String	The type of target. Supported values: SUM, VISIT, and COUNT. To use SUM, set the value as EVENT_ATTRIBUTE and then define the details in the extendedFieldInfo object.
defaultValues	Array	An array of objects providing default values related to the target.
- targetName	String	Name of the target.
- periodId	Integer	Unique identifier for the period.
- defaultValue	Integer	A default value used in the target evaluation.
extendedFieldInfo	Object	Includes the details of the event attribute that needs to be tracked. This object is applicable only when targetType is SUM.
- name	String	Event on which the sum calculation is performed. For example, the number of adding to cart events.
- aggregateFunction	String	The aggregate function checks whether the behavioral event is satisfied based on the sum. Supported values: SUM

Response parameters

Field	Data Type	Description
id	Integer	Unique ID of the target group
name	String	Unique name of the target group
fromDate	String	Indicates the start date of the target.
toDate	String	Indicates the end date of the target.
active	Boolean	Indicates if target tracking is active
preferredTillId	Number	Identifier for the preferred POS till
periods	Object	Details on target creation, updates, and time-frame
-id	Integer	The unique ID of the target period
-attribution	Object	Details on the creation and update details of the target period
--createdOn	String	Date the target period was created in ISO 8601 `YYYY-MM-DDTHH:mm:ss.SSS` format
--createdOnISO	String	Indicates the date and time when the target period was created in ISO 8601 format
--lastUpdatedOn	String	Date the target period was last updated in ISO 8601 `YYYY-MM-DDTHH:mm:ss.SSS` format
--lastUpdatedOnISO	String	Indicates the date and time when the target period was last updated in ISO 8601 format
--lastUpdatedBy	Object	Details on updates to the target period
---id	Integer	Unique ID of the user who last modified the target period
---code	String	Code of the user who last modified the target period
---description	String	Description of the user who last modified the target period
---name	String	Name of the user who last modified the target period
---type	String	Type of user who last modified the target period
--createdBy	Object	Details on creation of the target period
---id	Integer	Unique ID of the user who created the target period
---code	String	Code of the user who created the target period
---description	String	Description of the user who created the target period
---name	String	Name of the user who created the target period
---type	String	Type of user who created the target period
-startDate	String	Start date of the target group, in `YYYY-MM-DD` format
-endDate	String	End date of the target group, in `YYYY-MM-DD` format
-refCode	String	Reference code of the target period
-periodStatus	String	Current status of the target period
-targetGroupId	Integer	Unique ID of the target group
-description	String	Description of the target group
-active	Boolean	Current active status of the target period
totalPeriods	Integer	Total number of periods for the target group
targetEvaluationType	Enum	Evaluation strategy for the target
recurringCycles	Number	Number of cycles for which the tracking recurs
frequency	Number	Frequency count, based on the frequency type
targetCycleStartDate	String	Indicates the start date and time of the target cycle
targetCycleEndDate	String	Indicates the end date and time of the target cycle
targetCycleStartDateISO	String	Indicates the start date and time of the target cycle in ISO 8601 format
targetCycleEndDateISO	String	Indicates the end date and time of the target cycle in ISO 8601 format
trackingType	Enum	The type of tracking the milestone is created for
targets	Object	Details on creation of the target
-id	Integer	Unique ID of the target
-attribution	Object	Details on the creation and update details of the target
--createdOn	String	Date the target was created in ISO 8601 format
--createdOnISO	String	Indicates the date and time when the target was created in ISO 8601 format
--lastUpdatedOn	String	Date the target was last updated in ISO 8601 format
--lastUpdatedOnISO	String	Indicates the date and time when the target was last updated in ISO 8601 format
--lastUpdatedBy	Object	Details on updates to the target
---id	Integer	Unique ID of the user who last modified the target
---code	String	Code of the user who last modified the target
---description	String	Description of the user who last modified the target
---name	String	Name of the user who last modified the target
---type	String	Type of user who last modified the target
--createdBy	Object	Details on creation of the target
---id	Integer	Unique ID of the user who created the target
---code	String	Code of the user who created the target
---description	String	Description of the user who created the target
---name	String	Name of the user who created the target
---type	String	Type of user who created the target
--name	String	Unique name for the target
--emfRuleSetId	Integer	Unique identifier of the ruleset that defines the conditions used to evaluate or process the target.
--targetType	String	The type of target. Possible values: `COUNT`, `EVENT_ATTRIBUTE`, `VISIT`
--targetEntity	Enum	The KPI on which the target is tracked
--eventName	String	Name of the event that triggers the target
--targetGroupId	Integer	Unique ID of the target group associated with the target
--active	Boolean	Current active status of the target
--expression	Boolean	Indicates if the target has an expression for evaluation
--expressionJson	String	A JSON expression that specifies the conditions required to achieve the target
--filters	Object	Details on the scope filters active on the target
--enrolmentMethod	Enum	The method of enrolment for the target
--defaultValues	Object	Details on the default values for the target
---id	Integer	Unique identifier of the default values used for specific target period.
---periodId	Integer	Unique identifier of the period associated with the default value.
---defaultValue	Float	A default value used in the target evaluation
--targetPeriodDefaultValuesMap	Object	Details on the default values for the target period
--extendedFieldInfo	Object	Details on extended field information for the event.
---name	String	The name of the extended field parameter that is tracked for this target. This identifies which custom field or extended attribute from the event data will be monitored.
---aggregateFunction	String	The aggregation method used to calculate values from the tracked parameter. Possible values: `SUM` and `COUNT`.
leaderboardEnabled	Boolean	Indicates if the leaderboard feature is enabled
userCreated	Boolean	Indicates if the target is user-created
timeZoneName	String	Specifies the timezone where the target group was created
errors	null or Object	Contains error details if any occurred during the API request
warnings	null or Object	Contains warning details if any occurred during the API request

{
    "data": {
        "id": 2911,
        "name": "uatTargetGroupBE01",
        "fromDate": "2026-01-01",
        "toDate": "2026-01-01",
        "active": true,
        "preferredTillId": 75155297,
        "periods": [
            {
                "id": 31623,
                "attribution": {
                    "createdOn": "2026-01-13T05:13:18.000+0000",
                    "createdOnISO": "2026-01-13T05:13:18Z",
                    "lastUpdatedOn": "2026-01-13T05:13:18.000+0000",
                    "lastUpdatedOnISO": "2026-01-13T05:13:18Z",
                    "lastUpdatedBy": {
                        "id": 75152721,
                        "code": "naman_doc",
                        "description": "",
                        "name": "naman",
                        "type": "TILL"
                    },
                    "createdBy": {
                        "id": 75152721,
                        "code": "naman_doc",
                        "description": "",
                        "name": "naman",
                        "type": "TILL"
                    }
                },
                "startDate": "2025-07-17",
                "endDate": "2025-07-18",
                "refCode": "Cycle_1",
                "periodStatus": "ENDED",
                "targetGroupId": 2911,
                "description": "p1",
                "active": true
            },
            {
                "id": 31624,
                "attribution": {
                    "createdOn": "2026-01-13T05:13:18.000+0000",
                    "createdOnISO": "2026-01-13T05:13:18Z",
                    "lastUpdatedOn": "2026-01-13T05:13:18.000+0000",
                    "lastUpdatedOnISO": "2026-01-13T05:13:18Z",
                    "lastUpdatedBy": {
                        "id": 75152721,
                        "code": "naman_doc",
                        "description": "",
                        "name": "naman",
                        "type": "TILL"
                    },
                    "createdBy": {
                        "id": 75152721,
                        "code": "naman_doc",
                        "description": "",
                        "name": "naman",
                        "type": "TILL"
                    }
                },
                "startDate": "2025-07-19",
                "endDate": "2025-07-20",
                "refCode": "Cycle_2",
                "periodStatus": "ENDED",
                "targetGroupId": 2911,
                "description": "p2",
                "active": true
            }
        ],
        "totalPeriods": 2,
        "targetEvaluationType": "FIXED_CALENDAR_WINDOW",
        "recurringCycles": 1,
        "frequency": 1,
        "targetCycleStartDate": "2025-07-17T00:00:00.529Z",
        "targetCycleEndDate": "2026-02-01T05:00:00.000Z",
        "targetCycleStartDateISO": "2025-07-17T00:00:00Z",
        "targetCycleEndDateISO": "2026-02-01T05:00:00Z",
        "trackingType": "DEFAULT",
        "targets": [
            {
                "id": 3147,
                "attribution": {
                    "createdOn": "2026-01-13T05:13:17.578+0000",
                    "createdOnISO": "2026-01-13T05:13:17Z",
                    "lastUpdatedOn": "2026-01-13T05:13:17.578+0000",
                    "lastUpdatedOnISO": "2026-01-13T05:13:17Z",
                    "lastUpdatedBy": {
                        "id": 75152721,
                        "code": "naman_doc",
                        "description": "",
                        "name": "naman",
                        "type": "TILL"
                    },
                    "createdBy": {
                        "id": 75152721,
                        "code": "naman_doc",
                        "description": "",
                        "name": "naman",
                        "type": "TILL"
                    }
                },
                "name": "uat_target_group_be_01",
                "emfRuleSetId": 126470218,
                "targetType": "COUNT",
                "targetEntity": "EVENT",
                "eventName": "TestingEvent_FE",
                "targetGroupId": 2911,
                "active": true,
                "expression": "true",
                "expressionJson": "{\"arity\":\"literal\",\"value\":\"true\",\"type\":\"boolean:primitive\"}",
                "filters": [],
                "enrolmentMethod": "TRANSACTION",
                "defaultValues": [
                    {
                        "id": 128501,
                        "periodId": 31623,
                        "defaultValue": 2
                    },
                    {
                        "id": 128502,
                        "periodId": 31624,
                        "defaultValue": 3
                    }
                ],
                "targetPeriodDefaultValuesMap": {
                    "31623": {
                        "id": 128501,
                        "periodId": 31623,
                        "defaultValue": 2
                    },
                    "31624": {
                        "id": 128502,
                        "periodId": 31624,
                        "defaultValue": 3
                    }
                },
                "extendedFieldInfo": {
                    "name": "price",
                    "aggregateFunction": "SUM"
                }
            }
        ],
        "leaderboardEnabled": false,
        "userCreated": false,
        "timeZoneName": "GMT"
    },
    "errors": null,
    "warnings": null
}

{
    "data": {
        "id": 2913,
        "name": "uatTargetGroupBE02",
        "fromDate": "2026-01-01",
        "toDate": "2026-01-01",
        "active": true,
        "preferredTillId": 75155297,
        "periods": [
            {
                "id": 31627,
                "attribution": {
                    "createdOn": "2026-01-13T05:19:28.000+0000",
                    "createdOnISO": "2026-01-13T05:19:28Z",
                    "lastUpdatedOn": "2026-01-13T05:19:28.000+0000",
                    "lastUpdatedOnISO": "2026-01-13T05:19:28Z",
                    "lastUpdatedBy": {
                        "id": 75152721,
                        "code": "naman_doc",
                        "description": "",
                        "name": "naman",
                        "type": "TILL"
                    },
                    "createdBy": {
                        "id": 75152721,
                        "code": "naman_doc",
                        "description": "",
                        "name": "naman",
                        "type": "TILL"
                    }
                },
                "startDate": "2025-07-17",
                "endDate": "2025-07-18",
                "refCode": "Cycle_1",
                "periodStatus": "ENDED",
                "targetGroupId": 2913,
                "description": "p1",
                "active": true
            },
            {
                "id": 31628,
                "attribution": {
                    "createdOn": "2026-01-13T05:19:28.000+0000",
                    "createdOnISO": "2026-01-13T05:19:28Z",
                    "lastUpdatedOn": "2026-01-13T05:19:28.000+0000",
                    "lastUpdatedOnISO": "2026-01-13T05:19:28Z",
                    "lastUpdatedBy": {
                        "id": 75152721,
                        "code": "naman_doc",
                        "description": "",
                        "name": "naman",
                        "type": "TILL"
                    },
                    "createdBy": {
                        "id": 75152721,
                        "code": "naman_doc",
                        "description": "",
                        "name": "naman",
                        "type": "TILL"
                    }
                },
                "startDate": "2025-07-19",
                "endDate": "2025-07-20",
                "refCode": "Cycle_2",
                "periodStatus": "ENDED",
                "targetGroupId": 2913,
                "description": "p2",
                "active": true
            }
        ],
        "totalPeriods": 2,
        "targetEvaluationType": "FIXED_CALENDAR_WINDOW",
        "recurringCycles": 1,
        "frequency": 1,
        "targetCycleStartDate": "2025-07-17T00:00:00.529Z",
        "targetCycleEndDate": "2026-02-01T05:00:00.000Z",
        "targetCycleStartDateISO": "2025-07-17T00:00:00Z",
        "targetCycleEndDateISO": "2026-02-01T05:00:00Z",
        "trackingType": "DEFAULT",
        "targets": [
            {
                "id": 3148,
                "attribution": {
                    "createdOn": "2026-01-13T05:19:28.442+0000",
                    "createdOnISO": "2026-01-13T05:19:28Z",
                    "lastUpdatedOn": "2026-01-13T05:19:28.442+0000",
                    "lastUpdatedOnISO": "2026-01-13T05:19:28Z",
                    "lastUpdatedBy": {
                        "id": 75152721,
                        "code": "naman_doc",
                        "description": "",
                        "name": "naman",
                        "type": "TILL"
                    },
                    "createdBy": {
                        "id": 75152721,
                        "code": "naman_doc",
                        "description": "",
                        "name": "naman",
                        "type": "TILL"
                    }
                },
                "name": "uat_target_group_be_02",
                "emfRuleSetId": 126470219,
                "targetType": "EVENT_ATTRIBUTE",
                "targetEntity": "EVENT",
                "eventName": "TestingEvent_FE",
                "targetGroupId": 2913,
                "active": true,
                "expression": "true",
                "expressionJson": "{\"arity\":\"literal\",\"value\":\"true\",\"type\":\"boolean:primitive\"}",
                "filters": [],
                "enrolmentMethod": "TRANSACTION",
                "defaultValues": [
                    {
                        "id": 128503,
                        "periodId": 31627,
                        "defaultValue": 2
                    },
                    {
                        "id": 128504,
                        "periodId": 31628,
                        "defaultValue": 3
                    }
                ],
                "targetPeriodDefaultValuesMap": {
                    "31627": {
                        "id": 128503,
                        "periodId": 31627,
                        "defaultValue": 2
                    },
                    "31628": {
                        "id": 128504,
                        "periodId": 31628,
                        "defaultValue": 3
                    }
                },
                "extendedFieldInfo": {
                    "name": "Customer",
                    "aggregateFunction": "SUM"
                }
            }
        ],
        "leaderboardEnabled": false,
        "userCreated": false,
        "timeZoneName": "GMT"
    },
    "errors": null,
    "warnings": null
}

API error codes

Code	Description
310069	Target group name already exists
300004	Invalid input, check all values and ensure they are correct.
310008	Length of Target rule name cannot exceed 200

This API is being phased out and will no longer be available for creating new milestones.

Behavioral Events Target Group API

Note

Note

API endpoint example

Request Body Example

Prerequisites

Resource information

Request body parameters

Request body parameters (that are related to target)

Response parameters

API error codes

200200

201Created

400400