Get a single Campaign
Get a particular Campaign
object
Parameter
Accessible via URL https://api.channel.io/open/v5/mkt/campaigns/{id}
and HTTP GET
Parameter | Example | Required | Description | Parameter Type |
---|---|---|---|---|
id | 1234 | Required | ID of Campaign object | Path |
Example
GET https://api.channel.io/open/v5/mkt/campaigns/1234
Response
Returns a Campaign
object and a list of CampaignMsg
objects along with related information
{
"campaign": {
"id": "string",
"channelId": "string",
"name": "string",
"state": "draft",
"sendMedium": "appAlimtalk",
"userQuery": {
"key": "string",
"type": "boolean",
"operator": {},
"values": [
{}
],
"and": [
null
],
"or": [
null
]
},
"triggerEventName": "string",
"triggerEventQuery": {
"key": "string",
"type": "boolean",
"operator": {},
"values": [
{}
],
"and": [
null
],
"or": [
null
]
},
"waitingTime": {
"seconds": 0,
"nano": 0,
"negative": true,
"zero": true,
"units": [
{
"dateBased": true,
"timeBased": true,
"duration": {
"seconds": 0,
"nano": 0,
"negative": true,
"zero": true
},
"durationEstimated": true
}
]
},
"filterEventName": "string",
"filterEventQuery": {
"key": "string",
"type": "boolean",
"operator": {},
"values": [
{}
],
"and": [
null
],
"or": [
null
]
},
"filterMatch": "positive",
"goalEventName": "string",
"goalEventQuery": {
"key": "string",
"type": "boolean",
"operator": {},
"values": [
{}
],
"and": [
null
],
"or": [
null
]
},
"goalEventDuration": {
"seconds": 0,
"nano": 0,
"negative": true,
"zero": true,
"units": [
{
"dateBased": true,
"timeBased": true,
"duration": {
"seconds": 0,
"nano": 0,
"negative": true,
"zero": true
},
"durationEstimated": true
}
]
},
"advertising": true,
"sendToOfflineXms": true,
"sendToOfflineEmail": true,
"cooldown": {
"seconds": 0,
"nano": 0,
"negative": true,
"zero": true,
"units": [
{
"dateBased": true,
"timeBased": true,
"duration": {
"seconds": 0,
"nano": 0,
"negative": true,
"zero": true
},
"durationEstimated": true
}
]
},
"sendMode": "always",
"sendTimeRanges": {
"timeRanges": [
{
"dayOfWeeks": [
"mon"
],
"from": 0,
"to": 0
}
]
},
"startAt": 1656032152400,
"endAt": 1656032152400,
"draft": {
"campaign": {},
"msgs": [
{
"vanilla": {
"id": "string",
"campaignId": "string",
"channelId": "string",
"name": "string",
"sendMedium": "appAlimtalk",
"settings": {
"type": "string"
},
"createdAt": 1656032152405,
"updatedAt": 1656032152405,
"sent": 0,
"view": 0,
"goal": 0,
"click": 0
}
}
]
},
"createdAt": 1656032152405,
"updatedAt": 1656032152405,
"sent": 0,
"view": 0,
"goal": 0,
"click": 0,
"userChatExpireDuration": {
"seconds": 0,
"nano": 0,
"negative": true,
"zero": true,
"units": [
{
"dateBased": true,
"timeBased": true,
"duration": {
"seconds": 0,
"nano": 0,
"negative": true,
"zero": true
},
"durationEstimated": true
}
]
},
"managerId": "string"
},
"msgs": [
{
"id": "string",
"campaignId": "string",
"channelId": "string",
"name": "string",
"sendMedium": "appAlimtalk",
"settings": {
"type": "string"
},
"createdAt": 1656032152405,
"updatedAt": 1656032152405,
"sent": 0,
"view": 0,
"goal": 0,
"click": 0
}
]
}
Updated 12 months ago