Common Models

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:

PropertyTypeDescription
targetIdintUnique identifier for a Target.
namestringThe name given to the Target when it was created.
typestringCan be Static or Dynamic. Static Targets are based on Saved Lists and Dynamic Targets are based on Saved Searches.
descriptionstringThe description given to the Target when it was created.
pointsintThe number of points used by a Target.
statusstringCan 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.
areSubgroupsStickyboolIndicates that any contact that meets the criteria of a Subgroup will remain in that Subgroup and not be reassigned based on new data.
isCreateAListboolWhether the Target includes Create a List (CAL)
isExportsboolWhether the Target includes Exports
isCanvassResultsboolWhether the Target includes Canvass Results
isCountsCrosstabsboolWhether the Target includes Counts and Crosstabs
dateLastEditedDateThe 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.
lastRunDetailLogobjectA TargetDetailLog object with the date of the last time a Target was run, and whether that run was flagged with an error.
subgroupsarrayAn array of Subgroup objects.

TargetDetailLog

A TargetDetailLog has the following properties:

PropertyTypeDescription
dateLastRunDateThe DateTime of the last instance the Target ran.
isErrorFlaggedboolWhether the Target's last run is flagged with an error.

Subgroup

Each Subgroup has the following properties:

PropertyTypeDescription
fullNameintThe long name for the Subgroup.
namestringThe medium name for the Subgroup.
subgroupIdintUnique identifier for a Subgroup.
subgroupOrderintThe 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.
subgroupPointsintThe number of points used by the Subgroup.
isAssociatedWithBadgesboolIndicates whether the Subgroup name is displayed on the contact record in the UI.