get https://{host}/v3/targetGroups/
This API allows you to fetch all the target groups based on the target group ID.
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
- Basic Authentication
- Default access group
API Specification
| URI | v3/targetGroups/{targetGroupId} |
| HTTP Method | GET |
| Pagination | No |
| Batch support | No |
| Rate limit information | None |
API endpoint example
https://eucrm.cc.capillarytech.com/v3/targetGroups/32
Request path parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| targetGroupId* | Integer | Group ID of the target to retrieve |
Request query parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| includePeriods | Boolean | Boolean flag to include target period. |
https://eucrm.cc.capillarytech.com/v3/targetGroups/{targetGroupId}
Response parameters
| Field | Datatype | Description |
|---|---|---|
| id | Integer | Unique identifier for the target group. |
| attribution.createdOn | Date-time | Creation date and time for the target group. |
| attribution.lastUpdatedOn | String | Last update date and time for the target group. |
| attribution.lastUpdatedBy.id | Integer | ID of the last user who updated the target group. |
| attribution.lastUpdatedBy.code | String | Code of the last user who updated the target group. |
| attribution.lastUpdatedBy.description | Null | Description of the last user who updated the target group. |
| attribution.lastUpdatedBy.name | String | Name of the last user who updated the target group. |
| attribution.lastUpdatedBy.type | String | Type of the last user who updated the target group, e.g., "ADMIN_USER". |
| attribution.createdBy.id | Integer | ID of the user who created the target group. |
| attribution.createdBy.code | String | Code of the user who created the target group. |
| attribution.createdBy.description | Null | Description of the user who created the target group (null). |
| attribution.createdBy.name | String | Name of the user who created the target group. |
| attribution.createdBy.type | String | Type of the user who created the target group, e.g., "ADMIN_USER". |
| name | String | Name of the target group, e.g., "billExtendedFieldsTracking". |
| fromDate | Date | Start date for the target group. |
| toDate | Date | End date for the target group. |
| active | Boolean | Indicates if the target group is active. |
| preferredTillId | Integer | Preferred till ID. |
| streaks[].id | Integer | Unique identifier for each streak. |
| streaks[].targetGroupId | Integer | Identifier linking each streak to a target group. |
| streaks[].name | String | Name of each streak. |
| streaks[].targetCountOfSequence | Integer | Target count of sequence for each streak. |
| activePeriod.id | Integer | Unique identifier for the active period. |
| activePeriod.startDate | Date | Start date for the active period. |
| activePeriod.endDate | Date | End date for the active period. |
| activePeriod.refCode | String | Reference code for the active period. |
| activePeriod.periodStatus | String | Status of the active period, e.g., "RUNNING". |
| activePeriod.targetGroupId | Integer | Identifier linking the active period to a target group. |
| activePeriod.active | Boolean | Indicates if the active period is active. |
| totalPeriods | Integer | Total number of periods specified. |
| targetEvaluationType | String | Type of target evaluation, e.g., "FIXED_CALENDAR_WINDOW". |
| recurringCycles | Integer | Number of recurring cycles specified (-1 for indefinite). |
| frequency | Integer | Frequency value set for the setting. |
| targetCycleStartDate | Date | Start date and time for the target cycle. |
| targetCycleEndDate | Date | End date and time for the target cycle. |
| frequencyType | String | Frequency type, e.g., "QUARTERLY". |
| trackingType | String | Type of tracking, e.g., "STREAKS". |
| createdOn | Long | Creation timestamp for the setting. |
{
"data": {
"id": 1253,
"attribution": {
"createdOn": "2023-08-29T07:18:49.000+0000",
"lastUpdatedOn": "2023-08-29T07:18:49.000+0000",
"lastUpdatedBy": {
"id": 4,
"code": "First",
"description": null,
"name": "First User",
"type": "ADMIN_USER"
},
"createdBy": {
"id": 4,
"code": "First",
"description": null,
"name": "First User",
"type": "ADMIN_USER"
}
},
"name": "billExtendedFieldsTracking",
"fromDate": "2023-08-29",
"toDate": "2023-11-28",
"active": true,
"preferredTillId": 50674058,
"streaks": [
{
"id": 1,
"attribution": {
"createdOn": null,
"lastUpdatedOn": null,
"lastUpdatedBy": {
"id": 4,
"code": "First",
"description": null,
"name": "First User",
"type": "ADMIN_USER"
},
"createdBy": {
"id": 4,
"code": "First",
"description": null,
"name": "First User",
"type": "ADMIN_USER"
}
},
"targetGroupId": 1253,
"name": "streaks_dummy",
"targetCountOfSequence": 1
},
{
"id": 2,
"attribution": {
"createdOn": null,
"lastUpdatedOn": null,
"lastUpdatedBy": {
"id": 4,
"code": "First",
"description": null,
"name": "First User",
"type": "ADMIN_USER"
},
"createdBy": {
"id": 4,
"code": "First",
"description": null,
"name": "First User",
"type": "ADMIN_USER"
}
},
"targetGroupId": 1253,
"name": "streaks_dummy2",
"targetCountOfSequence": 1
}
],
"activePeriod": {
"id": 1743,
"attribution": {
"createdOn": "2023-08-29T07:18:49.000+0000",
"lastUpdatedOn": "2023-08-29T07:18:49.000+0000",
"lastUpdatedBy": {
"id": 4,
"code": "First",
"description": null,
"name": "First User",
"type": "ADMIN_USER"
},
"createdBy": {
"id": 4,
"code": "First",
"description": null,
"name": "First User",
"type": "ADMIN_USER"
}
},
"startDate": "2023-08-29",
"endDate": "2023-11-28",
"refCode": "p1",
"periodStatus": "RUNNING",
"targetGroupId": 1253,
"active": true
},
"totalPeriods": 1,
"targetEvaluationType": "FIXED_CALENDAR_WINDOW",
"recurringCycles": -1,
"frequency": 0,
"targetCycleStartDate": "2023-08-29T00:00:00.000Z",
"targetCycleEndDate": "2023-11-28T23:59:59.000Z",
"frequencyType": "QUARTERLY",
"trackingType": "STREAKS",
"createdOn": 1693293529000
},
"errors": null,
"warnings": null
}