Skip to content

Campaigns

Returns list of campaigns in the system. Returned data can be limited with campaign_id, start and end query parameters.

Operations

Download campaigns as JSON

Request

GET https://api.zoined.com/v2/download/campaigns.json?limit=1000&offset=0&campaign_id=123k&start_date=2017-01-01&end_date=2017-01-31

Security
bearerAuth
Query
limitnumber

How many entries to return

Example:limit=1000
offsetnumber

Which offset to return data from

Example:offset=0
campaign_idstring

Returns data of Campaigns based on the given id

Example:campaign_id=123k
start_datestring

Return data starting from given date

Example:start_date=2017-01-01
end_datestring

Return data ending to given date

Example:end_date=2017-01-31
curl -i -X GET \
  'https://zapi-api.zoined.com/_mock/v2/download/campaigns.json?limit=1000&offset=0&campaign_id=123k&start_date=2017-01-01&end_date=2017-01-31' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
campaign_idstringrequired

Campaign ID

Example:"6344"
campaign_namestringrequired

Campaign name

Example:"February 2016"
campaign_typestring

Campaign type

Example:"Web"
start_datestring

Campaign Start Date (yyyy-mm-dd)

Example:"2016-02-01"
end_datestring

Campaign End Date (yyyy-mm-dd)

Example:"2016-02-29"
custom_field_1string

Custom Field 1

Example:"New"
custom_field_2string

Custom Field 2

Example:"New"
custom_field_3string

Custom Field 3

Example:"New"
custom_field_4string

Custom Field 4

Example:"New"
custom_field_5string

Custom Field 5

Example:"Old"
Response
{
  "campaign_id": "6344",
  "campaign_name": "February 2016",
  "campaign_type": "Web",
  "start_date": "2016-02-01",
  "end_date": "2016-02-29",
  "custom_field_1": "New",
  "custom_field_2": "New",
  "custom_field_3": "New",
  "custom_field_4": "New",
  "custom_field_5": "Old"
}