Danh sách Campaigns và chi tiết

Lấy danh sách campaigns

GET: https://<host-name>/api/v2/campaigns

Lấy chi tiết campaign

GET: https://<host-name>/api/v2/campaigns/{campaign_id}

GET https://<host-name>/api/v2/campaigns/{campaign_id}

Query Parameters

Name	Type	Description
sort	string	Sắp xếp kết quả theo thời gian: created_at hoặc updated_at, để dấu - nếu muốn sắp xếp giảm dần
page_size	string	Số lượng kết quả trả về / 1 trang, mặc định là 20
page	string	Trang hiện tại theo phân trang
identifier_id	string	ID member của doanh nghiệp. Nếu không truyền sẽ trả về danh sách tất cả các chiến dịch, nếu truyền sẽ trả về danh sách các chiến dịch mà member tham gia

Headers

Name	Type	Description
Authorization	string	Bearer {access_token}
Content-Type	string	application/x-www-form-urlencoded
X-Network-Id	string	2
X-Port-Type	string	PUB

200

{
    "status": "success",
    "data": "eyJpdiI6IlVSWlRPWEFJaC9QR2UrbnFtczJnN0E9PSIsInZhbHVlIjoiOTRVNGdOUVJvSGFCNTl4U1hFU2lOeDkwaDNrWlR6ZituTStLV0JzdXp2V05hTVFUS2NJejVBUFVaT2pJVFowclB6dHdPYVN3T2grcHVqZVBjTzk2MXVBcVVyYmpkUUlyVmpvL1BoalorNURaanEzeXhkOGUrTUhTcVRtMlRQSEM4SDFWQzFXK05UY1ZDSldJVDQ2VVRJTVV6em8yRThUc1grYXBjbFc1Z0YyeHJsTE5JU2V5L0JaR2NXUHlEaTY4dGFWeHlwM01UZ013cWlaMHFpV0JCMW96OUUxWU5lREUyTFZFekdGM3ZKYWpFeG5qQ0VmVVhlYnN4VEFzckx6WUZIeTlrODhDenRSL2pPSzRvL3Z2RndjQy93LzVXSDcrRXRGM3EyRDBsTW1nQUIrMzAxZmxFTGdWd3VFQ3gxTjdhVzFCaUM5L1M3cDZTdzNXRkdPY25nL1ptMThqa2NaNDNZeloyaHNZSy9JS1l4QjJTMHBaL3ljelhGWkFpOTVCN2pmWHVUQVp4Wld5c2pkY09lbjNZZ0JPWkhsTURJQUh0bVh3NFQrSGxKRXV5alk0ODcyK3JaTGJYdit5b0hCekZwOVJ5MWVIWkxkZjZJOTRZcUdPK0NjajdYZkVkKzZIUVJCK3dsaVVaTldrc2QrQjFsZnNWaTEza295YlpLcmhVOWxvWHRNaWgvSnJ4K3JVYTZPSjVURUE4T2ZlTy9pdE9aVDVuL3JnTkJZOWNBeEVXNEFGMlR2TDYxWGh6ZWNIMWcvVHBLS2tndEh4SEhmVUgrbDg5bUNWUjUvbjRhdGFTSS85RzNtK1c4YjdPOGNFNFlMUXNOT3A4ZHlPcTlyN0xuUDRiWVhOZFVlRTduZGRyallNSFZoNmFDajFPcWVJRmcyV2pvWkNjY3daS3owZ29vS01IL0VjYWlwc3F4MFdJeG1BVndYdkVqK09Eb2lWK25CNFV5b3VPSXlSL0tBOVplSFBZN1ZXU2JCUEg3eEY0MlRDak1rQ21MblNmZG11bmZkZUE4SGowQ1pNZ1ZyNmVldEExdUNUQnI5ZHlzVjU4VUZjUW1oSmcwczN1elFmTW13V3VoRjRJc0xHNzAvMEdDQ0NwbUg1M2NxVFFxdEZCNmR3OE9QZnFQaGJaempoOHhJNEV1QmJvc0Fka0taUjVqMTBJZGdvc2xkeHorSk1mU2dTeUN5c1BaakxPVlhNMG11Q25qRE43YkE4MkdxdGtjV0dFcTZoVE9rS090N2dBQ2Y3V0VRcG11ZmQ3Zk0xWFJBQnJhdHJ1SG50UDlFMlJMTVpyTVZkcEFqUTRiTUFuYXJieGVlSWVCeE9JL1RGQ3RWNUtLQ20yWDJNUEsySnE3SWxNY1krenA3ZDNVY3RtV1ZIVnBzb3VaVjlpb2xOb3d0N09oUkpCcy9SS3p6a1daVStPMUFBblZwek8rU0hVaGw5eUxWUjIvdWx6YXVtc0VmUmdRWndiK1g0bWViQkRvdmJBKzRNWkpiRGMyT2F2Z3lHWTM1aHo3M0RJNWJ3MUNJdUNSL1RwanBpNTMvQlFKZzJxZz09IiwibWFjIjoiYjBiZmQzMWEyMWYxZGJjMjM1MGIwYWU0NGY0NmZiNGMwY2I3MTgzNzNkZmM5M2IwMDQ4MjQ5ZmY4NzJkNWJhZSJ9"
}

Data sau giải mã:

{
   "campaigns":[
      {
         "id":252,
         "code":"CAM000000252",
         "name":"OCB OMNI MGM",
         "url":"https://ocb-omni.vn",
         "status":2,
         "max_commission_rate":"50",
         "max_commission_value":"6000000",
         "domain":"ocb-omni.vn",
         "click_type":2,
         "started_at":"2020-05-14 00:00:00",
         "ended_at":null,
         "logo":"https://statics-cdn.affgrow.com/files/campaigns/logo/1589445841_ocb-omni.vn.png",
         "created_at":"2020-05-14 15:44:02",
         "updated_at":"2020-05-26 13:52:51",
         "approved_rate":"0",
         "commission_type":"FIX",
         "commission_value":"50000",
         "label":"0",
         "contracts_count":27,
         "categories":[
            {
               "id": 2,
               "name": "Financial Services
            }
         ],
         "type":{
            "id":11,
            "name":"CPA"
         },
         "commissions":[
 
         ],
         "epc30":"150859.25",
         "cpa30":"765071.93",
         "approved30":0,
         "cvr30":"19.72",
         "click30":"71",
         "com30":"10711007",
         "segment_ids": []
      }
   ],
   "meta":{
      "total":1,
      "per_page":"2",
      "current_page":1,
      "last_page":1
   }
}

	Attribute	Description
1	ID	ID của campaign, dùng làm data để khai báo ở API khởi tạo referral link
2	code	Mã code của campaign
3	name	Tên campaign
4	url	Homepage của campaign
5	status	Trạng thái của campaign Status = 2: Activated
6	Max Commission Rate	% hoa hồng publisher có thể được nhận giúp tăng độ hấp dẫn của chiến dịch khi publisher lựa chọn
7	Max Commission Value	Số tiền hoa hồng publisher có thể được nhận giúp tăng độ hấp dẫn của chiến dịch khi publisher lựa chọn
8	started at	Ngày bắt đầu chạy campaign
9	end at	Ngày kết thúc campaign
10	approved_rate	Tỉ lệ duyệt trung bình của campaign trong 30 ngày gần nhất
11	lable	lable = 1 New Lable = 2 Hot
12	contract_count	số lượng publisher đã tham gia vào campaign
13	categories	Nhóm campaigns
14	Type name	Loại hình của campaign. Các loại hình CPA, CPO, CPL, CPS, MGM
15	event_code	Mã event của campaign Dùng để truyền event code vào API push event
16	segment_ids	Đối tượng được quyền tham gia vào campaign