List of Campaign Users

Retrieve a list of Campaign User objects

Parameter

Accessible via URL https://api.channel.io/open/v3/mkt/campaigns/{id}/campaign-users and HTTP GET

Parameter

Example

Required

Description

Parameter Type

id

1234

Required

ID of Campaign object

Path

state

sent (sent, view, goal, click)

Required

The type of Campaign User objects to be retrieved.

Query

since

eyJjaGF0S2V5IjoiZ3Jvn0=

Optional

Encoded key of the first Campaign User to be retrieved.
Pagination is supported along with the next value contained in the root object of the JSON response.

Query

limit

25

Optional

Restrict the maximum number of Campaign User objects to be retrieved.

  • min : 1
  • max : 500
  • default : 25

Query

sortOrder

desc (asc, desc)

Optional

Sorting order

  • default : desc

Query

Example

GET https://api.channel.io/open/v3/mkt/campaigns/1234/campaign-users?state=click&since=eyJjaGF0S2V5IjoiZ3Jvn0=&limit=25&sortOrder=desc

Response

Returns a list of Campaign User objects

{
  "next": "string",
  "campaignUsers": [
    {
      "campaignId": "string",
      "userId": "string",
      "msgId": "string",
      "sent": 1605925010501,
      "view": 1605925010501,
      "goal": 1605925010501,
      "click": 1605925010501,
      "version": 0,
      "id": "string"
    }
  ]
}

Implementation Note

🚧

The Campaign User is a target of the unify process. In other words, the Campaign User data will be unified if one is logged in afterwards.

🚧

The Campaign User objects who has been updated more than a year ago will not be retrieved.