Campaigns represent marketing campaigns within an app that take place in a period of time and usually target a segment of the users.
NOTE: Campaigns that are created or their end date is extended once they are finished/archived require the Start Campaign call.
The Campaign Object
| Name | Type | Obligatory? | Description |
|---|---|---|---|
| createdAt | long | Autogenerated | Creation date (timestamp UTC). |
| updatedAt | long | Autogenerated | Last modification date (timestamp UTC). |
| campaignId | string | Autogenerated | Campaign Identifier |
| appId | string | Yes | Application id. |
| config.name | string | Yes | Name of the Campaign. |
| config.description | string | No | Description of the Campaign. |
| config.type | enum | Yes | Type of the Campaign. Valid values: Proximity, Push. |
| config.startAt | long | Yes | Campaign start date (timestamp UTC). |
| config.endAt | long | Yes (For Proximity campaigns) | Campaign end date (timestamp UTC). |
| config.segmentId | string | No | Id of the target segment. |
| config.groupId* | string | No | Id of the Group this Campaign belongs to. |
| config.displayCap* | integer | No | Maximum number of experiences that will be triggered within the Campaign. |
| config.displayWaitMs* | integer | No | Minimum delay between experiences triggered within the Campaign. |
| config.recurrence.hoursOfDay | array | No | Array of hours when the Campaign can be triggered. E.g. [1, 2] will cause the Campaign to trigger only if the time is between 01:00 and 02:59, or 01:XX or 02:XX. |
| config.recurrence.daysOfWeek | array | No | Array of days when the Campaign can be triggered. Sunday=1, Monday=2, up to Saturday=7 |
| status | string | Autogenerated | Current status of the campaign. |
| statusAt | long | Autogenerated | Last status update date (timestamp UTC). |
Advanced settings
Fields marked with * will not be displayed in the response payload if not set.
{
"createdAt": 1494402647390,
"updatedAt": 1494498973170,
"appId": "IXa7Bl9oRo6c7zQ5aQIzlg",
"campaignId": "dexNkpsVRPKdgkh6d6uDgg",
"config": {
"name": "HQ Office Welcome",
"description": "Welcome experiences in our Office",
"type": "Proximity",
"startAt": 1494403200000,
"endAt": 1525939200000,
"segmentId": "fe9NBA8DRdCIDmmEhy3T2w",
"displayCap": 3,
"displayWaitMs": 1800000
},
"status": "New",
"statusAt": 1494498473833
}