List of Campaigns

Retrieve a list of Campaign objects

Parameter

Accessible via URL https://api.channel.io/open/v5/mkt/campaigns and HTTP GET

ParameterExampleRequiredDescriptionParameter Type
since1605795977290OptionalEpoch time in microseconds of the first Campaign to be retrieved.
Pagination is supported along with the next value contained in the root object of the JSON response.
Query
limit25OptionalRestrict the maximum number of results
- min : 1
- max : 500
- default : 25
Query
statesactiveOptionalA set of Campaign states to be retrieved.
- available values : draft, active, stopped
Query

Example

GET https://api.channel.io/open/v5/mkt/campaigns?since=1605795977290&limit=25&states=draft&states=active

Response

Returns a list of Campaign and CampaignMsg objects

{
  "next": 1656032146538,
  "campaigns": [
    {
      "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
    }
  ]
}