Campaigns

πŸ“˜

GET https://api.kayzen.io/v1/meta/campaigns

Returns campaign name and other campaign attributes. If no specific search query is specified, all campaign details are returned

Field

Param

Required/ Optional

Description

q

string

optional

Search query parameter. Returns result for a specific campaign. If no value is specified, then all campaigns data will be returned

per_page

int

optional

Number of rows per page. Default Value- 30 entries

page

int

optional

Returns page number. Default Value- 1 page

curl -X GET \
'https://api.kayzen.io/v1/meta/campaigns?page=1&per_page=25&q=FR_android_banner_CPI_BU' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer ACCESS_TOKEN'
{  
   "data":[  
      {  
         "status":"running",
         "id":139199,
         "name":"FR_android_banner",
         "detail_id":139199,
         "is_active":true,
         "order_active":true,
         "has_running_creatives":true,
         "creative_statuses":[  
            "running",
            "running",
            "running"
         ],
         "start_time":"2019-05-22T16:01:34.000Z",
         "end_time":"2038-01-01T00:00:00.000Z",
         "cap_type":"none",
         "budget_cap_amount":null,
         "budget_cap_interval":null,
         "objective_cap_amount":null,
         "objective_cap_interval":null,
         "cloned_from":138841,
         "creative_type":"image",
         "total_budget":null,
         "billing_type":null,
         "billing_price":0.0,
         "updated_at":"2019-05-22T15:16:42.000Z",
         "created_at":"2019-05-22T15:16:42.000Z",
         "tags":[  
            {  
               "id":40,
               "name":"autoblacklistOFF"
            },
            {  
               "id":42,
               "name":"Explore"
            },
            {  
               "id":33,
               "name":"User_acquisition"
            }
         ],
         "app_group_id_whitelist":null,
         "app_group_id_blacklist":null,
         "max_bid":4.0,
         "day_budget":60,
         "campaign_type":"cpi",
         "modified_by":{  
            "id":2375,
            "first_name":"Mr",
            "last_name":"API",
            "email":"[email protected]",
            "company":"Kayzen",
            "time_zone":"UTC",
            "status":"active",
            "created_at":"2019-04-15T10:33:38.000Z",
            "system_role":"account_manager",
            "external":false,
            "registered_at":"2019-04-15",
            "role":null
         },
         "created_by":{  
            "id":2375,
            "first_name":"Mr",
            "last_name":"API",
            "email":"[email protected]",
            "company":"Kayzen",
            "time_zone":"UTC",
            "status":"active",
            "created_at":"2019-04-15T10:33:38.000Z",
            "system_role":"account_manager",
            "external":false,
            "registered_at":"2019-04-15",
            "role":null
         },
         "advertiser":{  
            "id":12209,
            "name":"Stark",
            "created_at":"2019-02-20T12:04:52.000Z",
            "status":"active",
            "rtb_margin":"0.0",
            "advertiser_office_id":2,
            "conversion_objects":[  

            ],
            "s2s_enabled":true,
            "mobile_object_enabled":false,
            "advertiser_api_key":{  
               "id":2848,
               "api_key":"e59413db1cb4e10582e0282829989fd889a8d39a",
               "api_secret":null,
               "advertiser_id":12209,
               "created_at":"2019-02-20T12:04:53.000Z",
               "updated_at":"2019-02-20T12:04:53.000Z"
            }
         },
         "enterprise":{  
            "id":10049,
            "name":"Kayzen",
            "created_at":"2018-12-05T15:23:14.000Z"
         },
         "geolocations":[  

         ]
      }
   ],
   "meta":{  
      "current_page":1,
      "total_pages":1,
      "total_entries":1
   }
}