Create a New Campaign
HTTP method
EndPoint
POST
/campaign

Request body example

1
curl -X POST -H "X-Api-Key: {key}" -H "Content-Type: application/json" -H "Cache-Control: no-cache" -H "Postman-Token: cc5d7610-80aa-8f1b-983d-fc5712fcfb53" -d '{
2
"title": "API Campaign",
3
"description": "This is a test campaign created using API",
4
"preview_url": "http://google.com/",
5
"url": "http://www.google.co.in/?utm_source={click_id}",
6
"advertiser_id": "3",
7
"status": "pending",
8
"category": ["Technology", "Entertainment"],
9
"currency": "USD",
10
"model": "cpa",
11
"os": ["android","ios"],
12
"os_ver": {
13
"android": {
14
"min": 4,
15
"max": 10
16
}
17
}
18
"commissions": [
19
{
20
"payout": 1,
21
"revenue": 2,
22
"coverage": ["US", "IN"]
23
},
24
{
25
"payout": 0.5,
26
"revenue": 1,
27
"coverage": ["ALL"]
28
}
29
],
30
"caps": [
31
{
32
"type":"revenue",
33
"monthly": 30,
34
"daily": 1,
35
"lifetime":10000,
36
"pc": 0,
37
"pub_id": "5c9dca40b6920d57e15f1aa0",
38
"geo": [
39
"US",
40
"IN"
41
]
42
}
43
]
44
}' "https://api.trackier.com/campaign"
Copied!

Request body parameters

Field
Type
Description
Nullable
title*
string
Title of the campaign
No
description
string
Description of the campaign
Yes
url*
string
Url of the campaign
No
image
string
Url of the image (which is downloadable)
Yes
preview_url
string
Preview URL of campaign
Yes
device
array
Device array
Yes
os
array
Operating System (all/android/ios)
Yes
os_ver
object
Operating System Version Info
Yes
category
array
Categories array
Yes
advertiser_id*
string
Advertiser ID
No
commissions*
array of objects
Campaign Commissions
No
caps
array of objects
Campaign CAPs
Yes
model*
string
CPA, CPC, CPI, CPM (default: CPA)
No
currency
string
3 letter currency code (example: USD)
Yes
status
string
active, pending, paused, disabled (default: pending)
Yes
visibility
string
public, private, permission (default: public)
Yes
app_name
string
App Name for campaign
Yes
app_id
string
App ID of campaign
Yes
conversion_tracking
string
postback, iframe_https, image_https (default: postback)
Yes
conversion_pixel_domain
string
pixel domain required when conversion tracking is not postback
Yes

Commission Object

Field
Type
Description
Nullable
payout*
float
Payout for the affiliate in Admin Currency (default: USD)
No
revenue*
float
Revenue charged from the advertiser Admin Currency (default: USD)
No
coverage
array
Array of country codes
Yes
  • User ID can be found from /advertiser
  • Fields marked with * are required

CAP Object

Field
Type
Description
Nullable
type
string
  • conversion
  • payout
  • revenue
  • click
  • pendingPayout
  • pendingRevenue
  • approvedConv
No
pub_id (Deprecated)
string
Publisher Long ID
Yes
pids
array
Publisher ID's
No
daily
integer
Daily CAP limit
Yes
monthly
integer
Monthly CAP Limit
Yes
lifetime
integer
Lifetime CAP Limit
Yes
pc
integer
0 - false/1 - true
Yes
geo
array
List of country codes
Yes
1
{
2
"success": true,
3
"data": {
4
"campaign": {
5
"user_id": "57c4738434243dc57d8b456d",
6
"org_id": "57c4718434243dc47d8b456b",
7
"display_id": 1807,
8
"title": "API Campaign 5",
9
"description": "This is a test campaign created using API",
10
"url": "http://www.google.co.in/?utm_source={click_id}",
11
"preview_url": "http://google.com/",
12
"image": null,
13
"os":["all"],
14
"os_ver": null,
15
"category": [
16
"Technology",
17
"Entertainment"
18
],
19
"currency": "USD",
20
"comm_model": "cpa",
21
"comm_type": "default",
22
"device": null,
23
"coverage": [
24
"US",
25
"IN",
26
"ALL"
27
],
28
"fire_global_aff_pb": true,
29
"os": [],
30
"os_ver": null,
31
"cities": [],
32
"isps": [],
33
"disabled_reason": null,
34
"blocked_pubs": [],
35
"fallback_url": null,
36
"cookie_duration": 90,
37
"app_name": null,
38
"app_id": null,
39
"def_goal": null,
40
"conv_tracking": "postback",
41
"convt_domain": null,
42
"vis": "private",
43
"cdt": null,
44
"_id": "5bebd18b89d44647667249f2",
45
"live": true,
46
"created": "2018-11-14",
47
"modified": "2018-11-14",
48
"meta": {},
49
"status": "active"
50
},
51
"commissions": [
52
{
53
"ad_id": "5bebd18b89d44647667249f2",
54
"tier_id": null,
55
"rate": 1,
56
"revenue": 2,
57
"coverage": [
58
"US",
59
"IN"
60
],
61
"_id": "5bebd18c89d44647667249f3"
62
},
63
{
64
"ad_id": "5bebd18b89d44647667249f2",
65
"tier_id": null,
66
"rate": 0.5,
67
"revenue": 1,
68
"coverage": [
69
"ALL"
70
],
71
"_id": "5bebd18c89d44647667249f4"
72
}
73
],
74
"caps": [
75
{
76
"pub_id": "ALL",
77
"ad_id": "5ca567dadc713839091cc064",
78
"type": "conversion",
79
"redirect": {
80
"type": "fallback_link"
81
},
82
"geo": [
83
"US"
84
],
85
"id": "5ca567dadc713839091cc067",
86
"daily": null,
87
"monthly": 10,
88
"lifetime": null,
89
"pause_campaign": 1
90
}
91
],
92
"message": "Campaign created Successfully!!"
93
}
94
}
Copied!
Last modified 1yr ago