The following is an example of a Target:
{
"targetId": 33,
"name": "GOTV Targets",
"type": "Dynamic",
"description": null,
"points": 273,
"areSubgroupsSticky": false,
"status": "Ready",
"dateLastEdited": "2023-10-04T17:53:00Z",
"isCreateAList": false,
"isExports": true,
"isCountsCrosstabs": false,
"isCanvassResults": true,
"lastRunDetailLog": {
"dateLastRun": "2023-10-04T19:03:47.56Z",
"isErrorFlagged": false
},
"subgroups": [
{
"fullName": "Excellent Voters",
"name": "Excellent",
"subgroupId": 123,
"subgroupOrder": 1,
"subgroupPoints": 54,
"isAssociatedWithBadges": false
},
{
"fullName": "Warm Voters",
"name": "Warm",
"subgroupId": 456,
"subgroupOrder": 2,
"subgroupPoints": 219,
"isAssociatedWithBadges": false
}
]
}
Target
Each Target has the following properties:
| Property | Type | Description |
|---|---|---|
targetId | int | Unique identifier for a Target. |
name | string | The name given to the Target when it was created. |
type | string | Can be Static or Dynamic. Static Targets are based on Saved Lists and Dynamic Targets are based on Saved Searches. |
description | string | The description given to the Target when it was created. |
points | int | The number of points used by a Target. |
status | string | Can be one of Setup, Ready, or Active. Setup means the Target is in the configuration process. Ready indicates that the Target is ready to be run in the nightly update. Active indicates that the Target has completed at least one nightly run. |
areSubgroupsSticky | bool | Indicates that any contact that meets the criteria of a Subgroup will remain in that Subgroup and not be reassigned based on new data. |
isCreateAList | bool | Whether the Target includes Create a List (CAL) |
isExports | bool | Whether the Target includes Exports |
isCanvassResults | bool | Whether the Target includes Canvass Results |
isCountsCrosstabs | bool | Whether the Target includes Counts and Crosstabs |
dateLastEdited | Date | The Date of the last time a user edited a Target's configuration, such as the Target's name, description, status, areSubGroupsSticky, isCreateAList, isExports, isCanvassResults, or isCountsCrosstabs. |
lastRunDetailLog | object | A TargetDetailLog object with the date of the last time a Target was run, and whether that run was flagged with an error. |
subgroups | array | An array of Subgroup objects. |
TargetDetailLog
A TargetDetailLog has the following properties:
| Property | Type | Description |
|---|---|---|
dateLastRun | Date | The DateTime of the last instance the Target ran. |
isErrorFlagged | bool | Whether the Target's last run is flagged with an error. |
Subgroup
Each Subgroup has the following properties:
| Property | Type | Description |
|---|---|---|
fullName | int | The long name for the Subgroup. |
name | string | The medium name for the Subgroup. |
subgroupId | int | Unique identifier for a Subgroup. |
subgroupOrder | int | The subgroup's sort order. The sort order determines the order that the subgroups get run in, and if multiple subgroups would match the same contact the first one in this order will be applied to the contact. |
subgroupPoints | int | The number of points used by the Subgroup. |
isAssociatedWithBadges | bool | Indicates whether the Subgroup name is displayed on the contact record in the UI. |