Apigility

SmartPublisher

GET /smart-publisher

Fields

Field	Type	Description	Required
id	integer	The id of smart publisher	NO
name	string	The name of smart publisher	YES
email	string	The email of smart publisher	YES
country	string	The country of smart publisher in country code	YES
status	string	The status of smart publisher. Possible values: "active", "inactive" or "suspended" (default: active)	NO
contact_info	Array	An array of objects containing contact information for this smart publisher	NO
tax	integer	Tax used in smart publisher earnings. Value in percentage, range from 0 to 100 (default:0)	NO
management_fee	integer	Management fee used in smart publisher earnings. Value in percentage, Range from 0 to 100 (default:0)	NO
revenue_sharing	integer	The revenue sharing of smart publisher. Value in percentage, Range from 0 to 100 (default:0)	NO
split_billing	boolean	Split billing based on site. Possible values: "true" or "false" (default:'false')	NO
premier_publisher	boolean	Premier publisher with additional features (ad preview). Possible values: "true" or "false" (default:'false')	NO
domain_checking	boolean	If true, ad will only served if domain matched. Possible values: "true" or "false" (default:'false')	NO
video_ad	boolean	Enable video zone creation. Possible values: "true" or "false" (default:'false')	NO
mobile_ad	boolean	Enable mobile zone creation. Possible values: "true" or "false" (default:'false')	NO
network_publisher	boolean	If this is a network publisher. Possible values: "true" or "false" (default:'false')	NO
all_channel_access	boolean	If true, all channel will be available to smart publisher. Possible values: "true" or "false" (default:'false')	NO
newsletter	boolean	If true, this smart publisher will be included in newsletter. Possible values: "true" or "false" (default:'false')	NO
report_by_model	boolean	If true, report will be available in model breakdown. Possible values: "true" or "false" (default: "false")	NO
manual_campaign_approval	boolean	If true, manual campaign approval is need to run any campaign. Possible values: "true" or "false" (default:'false')	NO
account_name	string	account name for payment	NO
site	Array	An array of objects containing site information of this smart publisher. (Read Only)	NO
history	Array	An array of objects containing history of this smart publisher. (Read Only)	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /smart-publisher

Fields

Field	Type	Description	Required
id	integer	The id of smart publisher	NO
name	string	The name of smart publisher	YES
email	string	The email of smart publisher	YES
country	string	The country of smart publisher in country code	YES
status	string	The status of smart publisher. Possible values: "active", "inactive" or "suspended" (default: active)	NO
contact_info	Array	An array of objects containing contact information for this smart publisher	NO
tax	integer	Tax used in smart publisher earnings. Value in percentage, range from 0 to 100 (default:0)	NO
management_fee	integer	Management fee used in smart publisher earnings. Value in percentage, Range from 0 to 100 (default:0)	NO
revenue_sharing	integer	The revenue sharing of smart publisher. Value in percentage, Range from 0 to 100 (default:0)	NO
split_billing	boolean	Split billing based on site. Possible values: "true" or "false" (default:'false')	NO
premier_publisher	boolean	Premier publisher with additional features (ad preview). Possible values: "true" or "false" (default:'false')	NO
domain_checking	boolean	If true, ad will only served if domain matched. Possible values: "true" or "false" (default:'false')	NO
video_ad	boolean	Enable video zone creation. Possible values: "true" or "false" (default:'false')	NO
mobile_ad	boolean	Enable mobile zone creation. Possible values: "true" or "false" (default:'false')	NO
network_publisher	boolean	If this is a network publisher. Possible values: "true" or "false" (default:'false')	NO
all_channel_access	boolean	If true, all channel will be available to smart publisher. Possible values: "true" or "false" (default:'false')	NO
newsletter	boolean	If true, this smart publisher will be included in newsletter. Possible values: "true" or "false" (default:'false')	NO
report_by_model	boolean	If true, report will be available in model breakdown. Possible values: "true" or "false" (default: "false")	NO
manual_campaign_approval	boolean	If true, manual campaign approval is need to run any campaign. Possible values: "true" or "false" (default:'false')	NO
account_name	string	account name for payment	NO
site	Array	An array of objects containing site information of this smart publisher. (Read Only)	NO
history	Array	An array of objects containing history of this smart publisher. (Read Only)	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /smart-publisher[/:smart_publisher_id]

Fields

Field	Type	Description	Required
id	integer	The id of smart publisher	NO
name	string	The name of smart publisher	YES
email	string	The email of smart publisher	YES
country	string	The country of smart publisher in country code	YES
status	string	The status of smart publisher. Possible values: "active", "inactive" or "suspended" (default: active)	NO
contact_info	Array	An array of objects containing contact information for this smart publisher	NO
tax	integer	Tax used in smart publisher earnings. Value in percentage, range from 0 to 100 (default:0)	NO
management_fee	integer	Management fee used in smart publisher earnings. Value in percentage, Range from 0 to 100 (default:0)	NO
revenue_sharing	integer	The revenue sharing of smart publisher. Value in percentage, Range from 0 to 100 (default:0)	NO
split_billing	boolean	Split billing based on site. Possible values: "true" or "false" (default:'false')	NO
premier_publisher	boolean	Premier publisher with additional features (ad preview). Possible values: "true" or "false" (default:'false')	NO
domain_checking	boolean	If true, ad will only served if domain matched. Possible values: "true" or "false" (default:'false')	NO
video_ad	boolean	Enable video zone creation. Possible values: "true" or "false" (default:'false')	NO
mobile_ad	boolean	Enable mobile zone creation. Possible values: "true" or "false" (default:'false')	NO
network_publisher	boolean	If this is a network publisher. Possible values: "true" or "false" (default:'false')	NO
all_channel_access	boolean	If true, all channel will be available to smart publisher. Possible values: "true" or "false" (default:'false')	NO
newsletter	boolean	If true, this smart publisher will be included in newsletter. Possible values: "true" or "false" (default:'false')	NO
report_by_model	boolean	If true, report will be available in model breakdown. Possible values: "true" or "false" (default: "false")	NO
manual_campaign_approval	boolean	If true, manual campaign approval is need to run any campaign. Possible values: "true" or "false" (default:'false')	NO
account_name	string	account name for payment	NO
site	Array	An array of objects containing site information of this smart publisher. (Read Only)	NO
history	Array	An array of objects containing history of this smart publisher. (Read Only)	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PATCH /smart-publisher[/:smart_publisher_id]

Fields

Field	Type	Description	Required
id	integer	The id of smart publisher	NO
name	string	The name of smart publisher	YES
email	string	The email of smart publisher	YES
country	string	The country of smart publisher in country code	YES
status	string	The status of smart publisher. Possible values: "active", "inactive" or "suspended" (default: active)	NO
contact_info	Array	An array of objects containing contact information for this smart publisher	NO
tax	integer	Tax used in smart publisher earnings. Value in percentage, range from 0 to 100 (default:0)	NO
management_fee	integer	Management fee used in smart publisher earnings. Value in percentage, Range from 0 to 100 (default:0)	NO
revenue_sharing	integer	The revenue sharing of smart publisher. Value in percentage, Range from 0 to 100 (default:0)	NO
split_billing	boolean	Split billing based on site. Possible values: "true" or "false" (default:'false')	NO
premier_publisher	boolean	Premier publisher with additional features (ad preview). Possible values: "true" or "false" (default:'false')	NO
domain_checking	boolean	If true, ad will only served if domain matched. Possible values: "true" or "false" (default:'false')	NO
video_ad	boolean	Enable video zone creation. Possible values: "true" or "false" (default:'false')	NO
mobile_ad	boolean	Enable mobile zone creation. Possible values: "true" or "false" (default:'false')	NO
network_publisher	boolean	If this is a network publisher. Possible values: "true" or "false" (default:'false')	NO
all_channel_access	boolean	If true, all channel will be available to smart publisher. Possible values: "true" or "false" (default:'false')	NO
newsletter	boolean	If true, this smart publisher will be included in newsletter. Possible values: "true" or "false" (default:'false')	NO
report_by_model	boolean	If true, report will be available in model breakdown. Possible values: "true" or "false" (default: "false")	NO
manual_campaign_approval	boolean	If true, manual campaign approval is need to run any campaign. Possible values: "true" or "false" (default:'false')	NO
account_name	string	account name for payment	NO
site	Array	An array of objects containing site information of this smart publisher. (Read Only)	NO
history	Array	An array of objects containing history of this smart publisher. (Read Only)	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

User

GET /user

Fields

Field	Type	Description	Required
id	integer	The id of user	NO
username	string	The log in username. Character must be alphabets or numbers or (.) or ( _ ) or ( @ ) only and between 6 and 20 characters	YES
password	string	The user password for log in. Password should be between 6 and 20 characters	YES
firstname	string	User first name	YES
lastname	string	User last name	NO
title	string	User title. Possible values: "Mr", "Ms" or "Mrs"	NO
gender	string	The gender of user. Possible values: "male " or "female"	YES
email	string	User email address	YES
address	string	User mailling address	NO
tel	string	Phone number of the person in charge	NO
fax	string	office fax number	NO
role_id	integer	The role of user. ID 6 for campaign manager, id 7,8,9,10 for sales	NO
country	string	The country of user in country code	YES
force_change_pw	integer	Force user to change their password. Possible values: "true" or "false" (default:'false')	NO
smart_publisher_id	integer	User smart publisher id.	NO
status	string	User status, Possible values: "active", "inactive" or "suspended" (default: active)	NO
advertiser_id	integer	Advertiser id.	NO
agency_id	integer	Agency id.	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /user

Fields

Field	Type	Description	Required
id	integer	The id of user	NO
username	string	The log in username. Character must be alphabets or numbers or (.) or ( _ ) or ( @ ) only and between 6 and 20 characters	YES
password	string	The user password for log in. Password should be between 6 and 20 characters	YES
firstname	string	User first name	YES
lastname	string	User last name	NO
title	string	User title. Possible values: "Mr", "Ms" or "Mrs"	NO
gender	string	The gender of user. Possible values: "male " or "female"	YES
email	string	User email address	YES
address	string	User mailling address	NO
tel	string	Phone number of the person in charge	NO
fax	string	office fax number	NO
role_id	integer	The role of user. ID 6 for campaign manager, id 7,8,9,10 for sales	NO
country	string	The country of user in country code	YES
force_change_pw	integer	Force user to change their password. Possible values: "true" or "false" (default:'false')	NO
smart_publisher_id	integer	User smart publisher id.	NO
status	string	User status, Possible values: "active", "inactive" or "suspended" (default: active)	NO
advertiser_id	integer	Advertiser id.	NO
agency_id	integer	Agency id.	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /user[/:user_id]

Fields

Field	Type	Description	Required
id	integer	The id of user	NO
username	string	The log in username. Character must be alphabets or numbers or (.) or ( _ ) or ( @ ) only and between 6 and 20 characters	YES
password	string	The user password for log in. Password should be between 6 and 20 characters	YES
firstname	string	User first name	YES
lastname	string	User last name	NO
title	string	User title. Possible values: "Mr", "Ms" or "Mrs"	NO
gender	string	The gender of user. Possible values: "male " or "female"	YES
email	string	User email address	YES
address	string	User mailling address	NO
tel	string	Phone number of the person in charge	NO
fax	string	office fax number	NO
role_id	integer	The role of user. ID 6 for campaign manager, id 7,8,9,10 for sales	NO
country	string	The country of user in country code	YES
force_change_pw	integer	Force user to change their password. Possible values: "true" or "false" (default:'false')	NO
smart_publisher_id	integer	User smart publisher id.	NO
status	string	User status, Possible values: "active", "inactive" or "suspended" (default: active)	NO
advertiser_id	integer	Advertiser id.	NO
agency_id	integer	Agency id.	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PATCH /user[/:user_id]

Fields

Field	Type	Description	Required
id	integer	The id of user	NO
username	string	The log in username. Character must be alphabets or numbers or (.) or ( _ ) or ( @ ) only and between 6 and 20 characters	YES
password	string	The user password for log in. Password should be between 6 and 20 characters	YES
firstname	string	User first name	YES
lastname	string	User last name	NO
title	string	User title. Possible values: "Mr", "Ms" or "Mrs"	NO
gender	string	The gender of user. Possible values: "male " or "female"	YES
email	string	User email address	YES
address	string	User mailling address	NO
tel	string	Phone number of the person in charge	NO
fax	string	office fax number	NO
role_id	integer	The role of user. ID 6 for campaign manager, id 7,8,9,10 for sales	NO
country	string	The country of user in country code	YES
force_change_pw	integer	Force user to change their password. Possible values: "true" or "false" (default:'false')	NO
smart_publisher_id	integer	User smart publisher id.	NO
status	string	User status, Possible values: "active", "inactive" or "suspended" (default: active)	NO
advertiser_id	integer	Advertiser id.	NO
agency_id	integer	Agency id.	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

Site

GET /site

Fields

Field	Type	Description	Required
id	integer	The site id	NO
smart_publisher_id	integer	The smart publisher id	YES
name	string	The site name	YES
url	string	Web site full URL	YES
channel_id	array	The channel id in array	YES
country	Array	The country which the site serve	YES
model_id	Array	The site cost type. Please refer to model service, not available for "Per Day" and "Per Week"	NO
language	Array	Language code that the site use. Possible values: "en"=English, "ms"=Bahasa Melayu, "zh"=Chinese, "ta"=Tamil, "id"=Bahasa Indonesia, "ja"=Japanese, "vi"=Vietnamese, "th"=Thai.	YES
description	string	A brief description about the site	NO
iframe	boolean	Site iframe. (default: false)	NO
status	string	Site status, Possible values: "active", "inactive" or "suspended" (default: active)	NO
history	Array	An array of objects containing history of this site. (Read Only)	NO
approved_date		The date of this site been approved. example: "2015-01-31"	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /site

Fields

Field	Type	Description	Required
id	integer	The site id	NO
smart_publisher_id	integer	The smart publisher id	YES
name	string	The site name	YES
url	string	Web site full URL	YES
channel_id	array	The channel id in array	YES
country	Array	The country which the site serve	YES
model_id	Array	The site cost type. Please refer to model service, not available for "Per Day" and "Per Week"	NO
language	Array	Language code that the site use. Possible values: "en"=English, "ms"=Bahasa Melayu, "zh"=Chinese, "ta"=Tamil, "id"=Bahasa Indonesia, "ja"=Japanese, "vi"=Vietnamese, "th"=Thai.	YES
description	string	A brief description about the site	NO
iframe	boolean	Site iframe. (default: false)	NO
status	string	Site status, Possible values: "active", "inactive" or "suspended" (default: active)	NO
history	Array	An array of objects containing history of this site. (Read Only)	NO
approved_date		The date of this site been approved. example: "2015-01-31"	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /site[/:site_id]

Fields

Field	Type	Description	Required
id	integer	The site id	NO
smart_publisher_id	integer	The smart publisher id	YES
name	string	The site name	YES
url	string	Web site full URL	YES
channel_id	array	The channel id in array	YES
country	Array	The country which the site serve	YES
model_id	Array	The site cost type. Please refer to model service, not available for "Per Day" and "Per Week"	NO
language	Array	Language code that the site use. Possible values: "en"=English, "ms"=Bahasa Melayu, "zh"=Chinese, "ta"=Tamil, "id"=Bahasa Indonesia, "ja"=Japanese, "vi"=Vietnamese, "th"=Thai.	YES
description	string	A brief description about the site	NO
iframe	boolean	Site iframe. (default: false)	NO
status	string	Site status, Possible values: "active", "inactive" or "suspended" (default: active)	NO
history	Array	An array of objects containing history of this site. (Read Only)	NO
approved_date		The date of this site been approved. example: "2015-01-31"	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PATCH /site[/:site_id]

Fields

Field	Type	Description	Required
id	integer	The site id	NO
smart_publisher_id	integer	The smart publisher id	YES
name	string	The site name	YES
url	string	Web site full URL	YES
channel_id	array	The channel id in array	YES
country	Array	The country which the site serve	YES
model_id	Array	The site cost type. Please refer to model service, not available for "Per Day" and "Per Week"	NO
language	Array	Language code that the site use. Possible values: "en"=English, "ms"=Bahasa Melayu, "zh"=Chinese, "ta"=Tamil, "id"=Bahasa Indonesia, "ja"=Japanese, "vi"=Vietnamese, "th"=Thai.	YES
description	string	A brief description about the site	NO
iframe	boolean	Site iframe. (default: false)	NO
status	string	Site status, Possible values: "active", "inactive" or "suspended" (default: active)	NO
history	Array	An array of objects containing history of this site. (Read Only)	NO
approved_date		The date of this site been approved. example: "2015-01-31"	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

Channel

GET /channel[/:channel_id]

Fields

Field	Type	Description	Required
id	integer	The id of channel	NO
name	string	The channel name	YES
description	string	The brief description of the channel	NO
open_to_publisher	boolean	Is the channel open to publisher	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

Zone

GET /zone

Fields

Field	Type	Description	Required
id	integer	The id of zone.	NO
name	string	The name of zone.	YES
width	integer	width of the zone	YES
height	integer	height of the zone	YES
house_ads	string	house ads for the zone if dint have running ads.	NO
alternate_url	string	Alternate URL for ads rotation, if don't have any targeted ads	NO
ad_position	string	Position of the ads in the site, Possible values: "Above the Fold", "Below the Fold", "Header", "Footer" or "Sidebar".	NO
status	string	The zone status, Possible values: "active" or "inactive" (default:"active").	NO
balloon	boolean	Supported Ad Formats type for this zone: Balloon, Yes or No. (default:"No").	NO
sto	boolean	Supported Ad Formats type for this zone: site take over, Possible values: "Yes" or "No" (default:"No").	NO
bts	boolean	Supported Ad Formats type for this zone: bottoms up, Possible values: "Yes" or "No" (default:"No").	NO
site_id	integer	The site id	NO
dimension_name	String	Dimension name of this zone. (Read Only)	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /zone

Fields

Field	Type	Description	Required
id	integer	The id of zone.	NO
name	string	The name of zone.	YES
width	integer	width of the zone	YES
height	integer	height of the zone	YES
house_ads	string	house ads for the zone if dint have running ads.	NO
alternate_url	string	Alternate URL for ads rotation, if don't have any targeted ads	NO
ad_position	string	Position of the ads in the site, Possible values: "Above the Fold", "Below the Fold", "Header", "Footer" or "Sidebar".	NO
status	string	The zone status, Possible values: "active" or "inactive" (default:"active").	NO
balloon	boolean	Supported Ad Formats type for this zone: Balloon, Yes or No. (default:"No").	NO
sto	boolean	Supported Ad Formats type for this zone: site take over, Possible values: "Yes" or "No" (default:"No").	NO
bts	boolean	Supported Ad Formats type for this zone: bottoms up, Possible values: "Yes" or "No" (default:"No").	NO
site_id	integer	The site id	NO
dimension_name	String	Dimension name of this zone. (Read Only)	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /zone[/:zone_id]

Fields

Field	Type	Description	Required
id	integer	The id of zone.	NO
name	string	The name of zone.	YES
width	integer	width of the zone	YES
height	integer	height of the zone	YES
house_ads	string	house ads for the zone if dint have running ads.	NO
alternate_url	string	Alternate URL for ads rotation, if don't have any targeted ads	NO
ad_position	string	Position of the ads in the site, Possible values: "Above the Fold", "Below the Fold", "Header", "Footer" or "Sidebar".	NO
status	string	The zone status, Possible values: "active" or "inactive" (default:"active").	NO
balloon	boolean	Supported Ad Formats type for this zone: Balloon, Yes or No. (default:"No").	NO
sto	boolean	Supported Ad Formats type for this zone: site take over, Possible values: "Yes" or "No" (default:"No").	NO
bts	boolean	Supported Ad Formats type for this zone: bottoms up, Possible values: "Yes" or "No" (default:"No").	NO
site_id	integer	The site id	NO
dimension_name	String	Dimension name of this zone. (Read Only)	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PATCH /zone[/:zone_id]

Fields

Field	Type	Description	Required
id	integer	The id of zone.	NO
name	string	The name of zone.	YES
width	integer	width of the zone	YES
height	integer	height of the zone	YES
house_ads	string	house ads for the zone if dint have running ads.	NO
alternate_url	string	Alternate URL for ads rotation, if don't have any targeted ads	NO
ad_position	string	Position of the ads in the site, Possible values: "Above the Fold", "Below the Fold", "Header", "Footer" or "Sidebar".	NO
status	string	The zone status, Possible values: "active" or "inactive" (default:"active").	NO
balloon	boolean	Supported Ad Formats type for this zone: Balloon, Yes or No. (default:"No").	NO
sto	boolean	Supported Ad Formats type for this zone: site take over, Possible values: "Yes" or "No" (default:"No").	NO
bts	boolean	Supported Ad Formats type for this zone: bottoms up, Possible values: "Yes" or "No" (default:"No").	NO
site_id	integer	The site id	NO
dimension_name	String	Dimension name of this zone. (Read Only)	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

Campaign

GET /campaign

Fields

Field	Type	Description	Required
id	integer	The id of campaign	NO
name	string	The name of campaign	YES
product	string	The name of product	YES
advertiser_id	integer	The advertiser id associated with this campaign. Refer to advertiser service	YES
agency_id	integer	The agency id associated with this campaign. Refer to agency service	NO
category_id	string	Campaign category id, example: "2_25". Refer to category service	YES
status	string	Status of the campaign. When creating new campaign, status is not required and will always be set to pending. Status approve and disapprove is only available when updating campaign with flight associated. A campaign must be in approve in order to serve any ads. Possible values: "pending", "approve", "disapprove" (default:"pending"). Proposed status only allowed for pending campaign. Possible values: "lead", "proposed_10", "proposed_50", "proposed_90", "lost", "waiting_approval".	NO
sales_person_id	integer	The sales person user id associated with this campaign. Refer to user service with role_id=7,8,9,10	YES
campaign_manager_id	integer	The campaign manager user id associated with this campaign. Refer to user service with role_id=6	YES
start_date	string	Start date of the campaign, example: "2015-01-01"	YES
end_date	string	End date of the campaign, example: "2015-01-31"	YES
billing_date	string	Billing date of the campaign, example: "2015-01-01" (default: start date will be used)	NO
country	string	The country for the campaign, refer to country service for a list of available country	YES
currency	string	Currency used on the campaign, example: "MYR". Refer to currency service for a list of available currency (default: according to country's currency)	NO
remarks	string	Remarks for campaign, maximum 255 chars	NO
sub_campaign_manager	string	The sub campaign manager user id associated with this campaign. Refer to user service with role_id=6. example: 1001,1002	NO
aio_verified	integer	. aio_verified	NO
aio_verified_by		aio_verified_by	NO
aio_verified_date			NO
aio_reject_remarks	string	Remarks for reject AIO, maximum 255 chars	NO
budget	double	Budget for campaign, possible values: 0-1000000000	NO
company	string	Read-only. The name of the company	NO
google_cloud_storage	string	Read-only. This determines if the campaign report is pushed into Google Cloud Storage.	NO

Request

Headers

Header	Value
Accept	application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "id": "[int]The id of campaign",
   "name": "[string]The name of campaign",
   "product": "[string]The name of product",
   "advertiser_id": "[int]The advertiser id associated with this campaign. Refer to advertiser service",
   "agency_id": "[int]The agency id associated with this campaign. Refer to agency service",
   "category_id": "[string]Campaign category id, example: "2_25". Refer to category service",
   "status": "[string]Status of the campaign. When creating new campaign, status is not required and will always be set to pending. Status approve and disapprove is only available when updating campaign with flight associated. A campaign must be in approve in order to serve any ads. Possible values: "pending", "approve", "disapprove" (default:"pending")",
   "sales_person_id": "[int]The sales person user id associated with this campaign. Refer to user service with role_id=7,8,9,10",
   "campaign_manager_id": "[int]The campaign manager user id associated with this campaign. Refer to user service with role_id=5",
   "start_date": "[string]Start date of the campaign, example: "2015-01-01"",
   "end_date": "[string]End date of the campaign, example: "2015-01-31"",
   "billing_date": "[string]Billing date of the campaign, example: "2015-01-01" (default: start date will be used)",
   "country": "[string]The country for the campaign, refer to country service for a list of available country",
   "currency": "[string]Currency used on the campaign, example: "MYR". Refer to currency service for a list of available currency (default: according to country's currency)"
}

POST /campaign

Fields

Field	Type	Description	Required
id	integer	The id of campaign	NO
name	string	The name of campaign	YES
product	string	The name of product	YES
advertiser_id	integer	The advertiser id associated with this campaign. Refer to advertiser service	YES
agency_id	integer	The agency id associated with this campaign. Refer to agency service	NO
category_id	string	Campaign category id, example: "2_25". Refer to category service	YES
status	string	Status of the campaign. When creating new campaign, status is not required and will always be set to pending. Status approve and disapprove is only available when updating campaign with flight associated. A campaign must be in approve in order to serve any ads. Possible values: "pending", "approve", "disapprove" (default:"pending"). Proposed status only allowed for pending campaign. Possible values: "lead", "proposed_10", "proposed_50", "proposed_90", "lost", "waiting_approval".	NO
sales_person_id	integer	The sales person user id associated with this campaign. Refer to user service with role_id=7,8,9,10	YES
campaign_manager_id	integer	The campaign manager user id associated with this campaign. Refer to user service with role_id=6	YES
start_date	string	Start date of the campaign, example: "2015-01-01"	YES
end_date	string	End date of the campaign, example: "2015-01-31"	YES
billing_date	string	Billing date of the campaign, example: "2015-01-01" (default: start date will be used)	NO
country	string	The country for the campaign, refer to country service for a list of available country	YES
currency	string	Currency used on the campaign, example: "MYR". Refer to currency service for a list of available currency (default: according to country's currency)	NO
remarks	string	Remarks for campaign, maximum 255 chars	NO
sub_campaign_manager	string	The sub campaign manager user id associated with this campaign. Refer to user service with role_id=6. example: 1001,1002	NO
aio_verified	integer	. aio_verified	NO
aio_verified_by		aio_verified_by	NO
aio_verified_date			NO
aio_reject_remarks	string	Remarks for reject AIO, maximum 255 chars	NO
budget	double	Budget for campaign, possible values: 0-1000000000	NO
company	string	Read-only. The name of the company	NO
google_cloud_storage	string	Read-only. This determines if the campaign report is pushed into Google Cloud Storage.	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json

Body

{
   "id": "[int]The id of campaign",
   "name": "[string]The name of campaign",
   "product": "[string]The name of product",
   "advertiser_id": "[int]The advertiser id associated with this campaign. Refer to advertiser service",
   "agency_id": "[int]The agency id associated with this campaign. Refer to agency service",
   "category_id": "[string]Campaign category id, example: "2_25". Refer to category service",
   "status": "[string]Status of the campaign. When creating new campaign, status is not required and will always be set to pending. Status approve and disapprove is only available when updating campaign with flight associated. A campaign must be in approve in order to serve any ads. Possible values: "pending", "approve", "disapprove" (default:"pending")",
   "sales_person_id": "[int]The sales person user id associated with this campaign. Refer to user service with role_id=7,8,9,10",
   "campaign_manager_id": "[int]The campaign manager user id associated with this campaign. Refer to user service with role_id=5",
   "start_date": "[string]Start date of the campaign, example: "2015-01-01"",
   "end_date": "[string]End date of the campaign, example: "2015-01-31"",
   "billing_date": "[string]Billing date of the campaign, example: "2015-01-01" (default: start date will be used)",
   "country": "[string]The country for the campaign, refer to country service for a list of available country",
   "currency": "[string]Currency used on the campaign, example: "MYR". Refer to currency service for a list of available currency (default: according to country's currency)"
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "id": "[int]The id of campaign",
   "name": "[string]The name of campaign",
   "product": "[string]The name of product",
   "advertiser_id": "[int]The advertiser id associated with this campaign. Refer to advertiser service",
   "agency_id": "[int]The agency id associated with this campaign. Refer to agency service",
   "category_id": "[string]Campaign category id, example: "2_25". Refer to category service",
   "status": "[string]Status of the campaign. When creating new campaign, status is not required and will always be set to pending. Status approve and disapprove is only available when updating campaign with flight associated. A campaign must be in approve in order to serve any ads. Possible values: "pending", "approve", "disapprove" (default:"pending")",
   "sales_person_id": "[int]The sales person user id associated with this campaign. Refer to user service with role_id=7,8,9,10",
   "campaign_manager_id": "[int]The campaign manager user id associated with this campaign. Refer to user service with role_id=5",
   "start_date": "[string]Start date of the campaign, example: "2015-01-01"",
   "end_date": "[string]End date of the campaign, example: "2015-01-31"",
   "billing_date": "[string]Billing date of the campaign, example: "2015-01-01" (default: start date will be used)",
   "country": "[string]The country for the campaign, refer to country service for a list of available country",
   "currency": "[string]Currency used on the campaign, example: "MYR". Refer to currency service for a list of available currency (default: according to country's currency)"
}

GET /campaign[/:campaign_id]

Fields

Field	Type	Description	Required
id	integer	The id of campaign	NO
name	string	The name of campaign	YES
product	string	The name of product	YES
advertiser_id	integer	The advertiser id associated with this campaign. Refer to advertiser service	YES
agency_id	integer	The agency id associated with this campaign. Refer to agency service	NO
category_id	string	Campaign category id, example: "2_25". Refer to category service	YES
status	string	Status of the campaign. When creating new campaign, status is not required and will always be set to pending. Status approve and disapprove is only available when updating campaign with flight associated. A campaign must be in approve in order to serve any ads. Possible values: "pending", "approve", "disapprove" (default:"pending"). Proposed status only allowed for pending campaign. Possible values: "lead", "proposed_10", "proposed_50", "proposed_90", "lost", "waiting_approval".	NO
sales_person_id	integer	The sales person user id associated with this campaign. Refer to user service with role_id=7,8,9,10	YES
campaign_manager_id	integer	The campaign manager user id associated with this campaign. Refer to user service with role_id=6	YES
start_date	string	Start date of the campaign, example: "2015-01-01"	YES
end_date	string	End date of the campaign, example: "2015-01-31"	YES
billing_date	string	Billing date of the campaign, example: "2015-01-01" (default: start date will be used)	NO
country	string	The country for the campaign, refer to country service for a list of available country	YES
currency	string	Currency used on the campaign, example: "MYR". Refer to currency service for a list of available currency (default: according to country's currency)	NO
remarks	string	Remarks for campaign, maximum 255 chars	NO
sub_campaign_manager	string	The sub campaign manager user id associated with this campaign. Refer to user service with role_id=6. example: 1001,1002	NO
aio_verified	integer	. aio_verified	NO
aio_verified_by		aio_verified_by	NO
aio_verified_date			NO
aio_reject_remarks	string	Remarks for reject AIO, maximum 255 chars	NO
budget	double	Budget for campaign, possible values: 0-1000000000	NO
company	string	Read-only. The name of the company	NO
google_cloud_storage	string	Read-only. This determines if the campaign report is pushed into Google Cloud Storage.	NO

Request

Headers

Header	Value
Accept	application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "id": "[int]The id of campaign",
   "name": "[string]The name of campaign",
   "product": "[string]The name of product",
   "advertiser_id": "[int]The advertiser id associated with this campaign. Refer to advertiser service",
   "agency_id": "[int]The agency id associated with this campaign. Refer to agency service",
   "category_id": "[string]Campaign category id, example: "2_25". Refer to category service",
   "status": "[string]Status of the campaign. When creating new campaign, status is not required and will always be set to pending. Status approve and disapprove is only available when updating campaign with flight associated. A campaign must be in approve in order to serve any ads. Possible values: "pending", "approve", "disapprove" (default:"pending")",
   "sales_person_id": "[int]The sales person user id associated with this campaign. Refer to user service with role_id=7,8,9,10",
   "campaign_manager_id": "[int]The campaign manager user id associated with this campaign. Refer to user service with role_id=5",
   "start_date": "[string]Start date of the campaign, example: "2015-01-01"",
   "end_date": "[string]End date of the campaign, example: "2015-01-31"",
   "billing_date": "[string]Billing date of the campaign, example: "2015-01-01" (default: start date will be used)",
   "country": "[string]The country for the campaign, refer to country service for a list of available country",
   "currency": "[string]Currency used on the campaign, example: "MYR". Refer to currency service for a list of available currency (default: according to country's currency)"
}

PATCH /campaign[/:campaign_id]

Fields

Field	Type	Description	Required
id	integer	The id of campaign	NO
name	string	The name of campaign	YES
product	string	The name of product	YES
advertiser_id	integer	The advertiser id associated with this campaign. Refer to advertiser service	YES
agency_id	integer	The agency id associated with this campaign. Refer to agency service	NO
category_id	string	Campaign category id, example: "2_25". Refer to category service	YES
status	string	Status of the campaign. When creating new campaign, status is not required and will always be set to pending. Status approve and disapprove is only available when updating campaign with flight associated. A campaign must be in approve in order to serve any ads. Possible values: "pending", "approve", "disapprove" (default:"pending"). Proposed status only allowed for pending campaign. Possible values: "lead", "proposed_10", "proposed_50", "proposed_90", "lost", "waiting_approval".	NO
sales_person_id	integer	The sales person user id associated with this campaign. Refer to user service with role_id=7,8,9,10	YES
campaign_manager_id	integer	The campaign manager user id associated with this campaign. Refer to user service with role_id=6	YES
start_date	string	Start date of the campaign, example: "2015-01-01"	YES
end_date	string	End date of the campaign, example: "2015-01-31"	YES
billing_date	string	Billing date of the campaign, example: "2015-01-01" (default: start date will be used)	NO
country	string	The country for the campaign, refer to country service for a list of available country	YES
currency	string	Currency used on the campaign, example: "MYR". Refer to currency service for a list of available currency (default: according to country's currency)	NO
remarks	string	Remarks for campaign, maximum 255 chars	NO
sub_campaign_manager	string	The sub campaign manager user id associated with this campaign. Refer to user service with role_id=6. example: 1001,1002	NO
aio_verified	integer	. aio_verified	NO
aio_verified_by		aio_verified_by	NO
aio_verified_date			NO
aio_reject_remarks	string	Remarks for reject AIO, maximum 255 chars	NO
budget	double	Budget for campaign, possible values: 0-1000000000	NO
company	string	Read-only. The name of the company	NO
google_cloud_storage	string	Read-only. This determines if the campaign report is pushed into Google Cloud Storage.	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

Flight

GET /flight

Fields

Field	Type	Description	Required
id	integer	The id of flight	NO
campaign_id	integer	ID of the campaign that this flight belongs to	YES
name	string	The name of flight	YES
flight_type	string	The flight type is only available on POST and not in PATCH, changing flight type is not available. Possible values: "premium" - served in specific premium publisher, "performance" - served in ad network channels	YES
platform	string	The platform is only available on POST and not in PATCH, changing platform is not available. Possible values: "web" - for deskktop, "mobile" - for mobile, "wifi" - for wifi. (Read Only)	NO
channels	Array	The channels associated with this flight. Refer to channel service. Required if flight_type is "performance"	NO
zone_id	integer	The zone id associated with this flight. Required if flight_type is "premium"	NO
zone_group_id	integer	The zone group id associated with this flight. This is only available when flight_type is "premium"	NO
start_date	string	Start date of the flight, example: "2015-01-01"	YES
end_date	string	End date of the campaign, example: "2015-01-31"	YES
full_date			NO
model_id	integer	Flight serving model, refer to model service	YES
inventory	integer	Total inventory of the flight, possible values: 1-100000000, and -1 as unlimited	YES
value_added			NO
base_media_cost	double	Base media cost of a single unit, possible values: 0-1000000, if this is not passed in, the value of media cost will be copied over	NO
media_cost	double	Media cost of a single unit, possible values: 0-1000000	YES
discount	double	Discount on flight cost, possible values: 0-100	NO
agency_commission	double	Agency commission, possible values: 0-100	NO
innity_commission	double	Innity commission, possible values: 0-100	NO
site_targets	array	Site targeting, array of site id to be targeted, example: array(1,2,3)	NO
site_blocks	array	Site blocking, array of site id to be blocked, site blocks will supersede site targets, example: array(1,2,3)	NO
segment_targets	array	DMP segment targeting, array of segments to be targeted, example: array(1,2)	NO
segment_blocks	array	DMP segment blocking, array of segments to be blocked, example: array(1,2)	NO
ad_inventory_allocation	array	Ad inventory allocation by percentage, array of ad id as key and percentage as value, only available for PATCH, example: array(1=>50, 2=>50)	NO
cost_after_discount	integer	. (Read Only)	NO
total_cost_after_discount	integer	. (Read Only)	NO
cost_after_agency_commission	integer	. (Read Only)	NO
cost_after_commission	integer	. (Read Only)	NO
rich_media_casual_cost	integer	. (Read Only)	NO
rich_media_discount	integer	. (Read Only)	NO
rich_media_cost_after_discount	integer	. (Read Only)	NO
rich_media_total_cost_after_discount	integer	. (Read Only)	NO
rich_media_cost_after_agency_commission	integer	. (Read Only)	NO
rich_media_cost_after_commission	integer	. (Read Only)	NO
rich_media_agency_commission	integer	. (Read Only)	NO
rich_media_commission	integer	. (Read Only)	NO
remarks	string	Remarks for the flight (Read Only)	NO
cpv_type	string	CPV type for CPV flight only (Read Only)	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /flight

Fields

Field	Type	Description	Required
id	integer	The id of flight	NO
campaign_id	integer	ID of the campaign that this flight belongs to	YES
name	string	The name of flight	YES
flight_type	string	The flight type is only available on POST and not in PATCH, changing flight type is not available. Possible values: "premium" - served in specific premium publisher, "performance" - served in ad network channels	YES
platform	string	The platform is only available on POST and not in PATCH, changing platform is not available. Possible values: "web" - for deskktop, "mobile" - for mobile, "wifi" - for wifi. (Read Only)	NO
channels	Array	The channels associated with this flight. Refer to channel service. Required if flight_type is "performance"	NO
zone_id	integer	The zone id associated with this flight. Required if flight_type is "premium"	NO
zone_group_id	integer	The zone group id associated with this flight. This is only available when flight_type is "premium"	NO
start_date	string	Start date of the flight, example: "2015-01-01"	YES
end_date	string	End date of the campaign, example: "2015-01-31"	YES
full_date			NO
model_id	integer	Flight serving model, refer to model service	YES
inventory	integer	Total inventory of the flight, possible values: 1-100000000, and -1 as unlimited	YES
value_added			NO
base_media_cost	double	Base media cost of a single unit, possible values: 0-1000000, if this is not passed in, the value of media cost will be copied over	NO
media_cost	double	Media cost of a single unit, possible values: 0-1000000	YES
discount	double	Discount on flight cost, possible values: 0-100	NO
agency_commission	double	Agency commission, possible values: 0-100	NO
innity_commission	double	Innity commission, possible values: 0-100	NO
site_targets	array	Site targeting, array of site id to be targeted, example: array(1,2,3)	NO
site_blocks	array	Site blocking, array of site id to be blocked, site blocks will supersede site targets, example: array(1,2,3)	NO
segment_targets	array	DMP segment targeting, array of segments to be targeted, example: array(1,2)	NO
segment_blocks	array	DMP segment blocking, array of segments to be blocked, example: array(1,2)	NO
ad_inventory_allocation	array	Ad inventory allocation by percentage, array of ad id as key and percentage as value, only available for PATCH, example: array(1=>50, 2=>50)	NO
cost_after_discount	integer	. (Read Only)	NO
total_cost_after_discount	integer	. (Read Only)	NO
cost_after_agency_commission	integer	. (Read Only)	NO
cost_after_commission	integer	. (Read Only)	NO
rich_media_casual_cost	integer	. (Read Only)	NO
rich_media_discount	integer	. (Read Only)	NO
rich_media_cost_after_discount	integer	. (Read Only)	NO
rich_media_total_cost_after_discount	integer	. (Read Only)	NO
rich_media_cost_after_agency_commission	integer	. (Read Only)	NO
rich_media_cost_after_commission	integer	. (Read Only)	NO
rich_media_agency_commission	integer	. (Read Only)	NO
rich_media_commission	integer	. (Read Only)	NO
remarks	string	Remarks for the flight (Read Only)	NO
cpv_type	string	CPV type for CPV flight only (Read Only)	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /flight[/:flight_id]

Fields

Field	Type	Description	Required
id	integer	The id of flight	NO
campaign_id	integer	ID of the campaign that this flight belongs to	YES
name	string	The name of flight	YES
flight_type	string	The flight type is only available on POST and not in PATCH, changing flight type is not available. Possible values: "premium" - served in specific premium publisher, "performance" - served in ad network channels	YES
platform	string	The platform is only available on POST and not in PATCH, changing platform is not available. Possible values: "web" - for deskktop, "mobile" - for mobile, "wifi" - for wifi. (Read Only)	NO
channels	Array	The channels associated with this flight. Refer to channel service. Required if flight_type is "performance"	NO
zone_id	integer	The zone id associated with this flight. Required if flight_type is "premium"	NO
zone_group_id	integer	The zone group id associated with this flight. This is only available when flight_type is "premium"	NO
start_date	string	Start date of the flight, example: "2015-01-01"	YES
end_date	string	End date of the campaign, example: "2015-01-31"	YES
full_date			NO
model_id	integer	Flight serving model, refer to model service	YES
inventory	integer	Total inventory of the flight, possible values: 1-100000000, and -1 as unlimited	YES
value_added			NO
base_media_cost	double	Base media cost of a single unit, possible values: 0-1000000, if this is not passed in, the value of media cost will be copied over	NO
media_cost	double	Media cost of a single unit, possible values: 0-1000000	YES
discount	double	Discount on flight cost, possible values: 0-100	NO
agency_commission	double	Agency commission, possible values: 0-100	NO
innity_commission	double	Innity commission, possible values: 0-100	NO
site_targets	array	Site targeting, array of site id to be targeted, example: array(1,2,3)	NO
site_blocks	array	Site blocking, array of site id to be blocked, site blocks will supersede site targets, example: array(1,2,3)	NO
segment_targets	array	DMP segment targeting, array of segments to be targeted, example: array(1,2)	NO
segment_blocks	array	DMP segment blocking, array of segments to be blocked, example: array(1,2)	NO
ad_inventory_allocation	array	Ad inventory allocation by percentage, array of ad id as key and percentage as value, only available for PATCH, example: array(1=>50, 2=>50)	NO
cost_after_discount	integer	. (Read Only)	NO
total_cost_after_discount	integer	. (Read Only)	NO
cost_after_agency_commission	integer	. (Read Only)	NO
cost_after_commission	integer	. (Read Only)	NO
rich_media_casual_cost	integer	. (Read Only)	NO
rich_media_discount	integer	. (Read Only)	NO
rich_media_cost_after_discount	integer	. (Read Only)	NO
rich_media_total_cost_after_discount	integer	. (Read Only)	NO
rich_media_cost_after_agency_commission	integer	. (Read Only)	NO
rich_media_cost_after_commission	integer	. (Read Only)	NO
rich_media_agency_commission	integer	. (Read Only)	NO
rich_media_commission	integer	. (Read Only)	NO
remarks	string	Remarks for the flight (Read Only)	NO
cpv_type	string	CPV type for CPV flight only (Read Only)	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PATCH /flight[/:flight_id]

Fields

Field	Type	Description	Required
id	integer	The id of flight	NO
campaign_id	integer	ID of the campaign that this flight belongs to	YES
name	string	The name of flight	YES
flight_type	string	The flight type is only available on POST and not in PATCH, changing flight type is not available. Possible values: "premium" - served in specific premium publisher, "performance" - served in ad network channels	YES
platform	string	The platform is only available on POST and not in PATCH, changing platform is not available. Possible values: "web" - for deskktop, "mobile" - for mobile, "wifi" - for wifi. (Read Only)	NO
channels	Array	The channels associated with this flight. Refer to channel service. Required if flight_type is "performance"	NO
zone_id	integer	The zone id associated with this flight. Required if flight_type is "premium"	NO
zone_group_id	integer	The zone group id associated with this flight. This is only available when flight_type is "premium"	NO
start_date	string	Start date of the flight, example: "2015-01-01"	YES
end_date	string	End date of the campaign, example: "2015-01-31"	YES
full_date			NO
model_id	integer	Flight serving model, refer to model service	YES
inventory	integer	Total inventory of the flight, possible values: 1-100000000, and -1 as unlimited	YES
value_added			NO
base_media_cost	double	Base media cost of a single unit, possible values: 0-1000000, if this is not passed in, the value of media cost will be copied over	NO
media_cost	double	Media cost of a single unit, possible values: 0-1000000	YES
discount	double	Discount on flight cost, possible values: 0-100	NO
agency_commission	double	Agency commission, possible values: 0-100	NO
innity_commission	double	Innity commission, possible values: 0-100	NO
site_targets	array	Site targeting, array of site id to be targeted, example: array(1,2,3)	NO
site_blocks	array	Site blocking, array of site id to be blocked, site blocks will supersede site targets, example: array(1,2,3)	NO
segment_targets	array	DMP segment targeting, array of segments to be targeted, example: array(1,2)	NO
segment_blocks	array	DMP segment blocking, array of segments to be blocked, example: array(1,2)	NO
ad_inventory_allocation	array	Ad inventory allocation by percentage, array of ad id as key and percentage as value, only available for PATCH, example: array(1=>50, 2=>50)	NO
cost_after_discount	integer	. (Read Only)	NO
total_cost_after_discount	integer	. (Read Only)	NO
cost_after_agency_commission	integer	. (Read Only)	NO
cost_after_commission	integer	. (Read Only)	NO
rich_media_casual_cost	integer	. (Read Only)	NO
rich_media_discount	integer	. (Read Only)	NO
rich_media_cost_after_discount	integer	. (Read Only)	NO
rich_media_total_cost_after_discount	integer	. (Read Only)	NO
rich_media_cost_after_agency_commission	integer	. (Read Only)	NO
rich_media_cost_after_commission	integer	. (Read Only)	NO
rich_media_agency_commission	integer	. (Read Only)	NO
rich_media_commission	integer	. (Read Only)	NO
remarks	string	Remarks for the flight (Read Only)	NO
cpv_type	string	CPV type for CPV flight only (Read Only)	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

Country

GET /country[/:country_id]

Fields

Field	Type	Description	Required
id	string	The id of country	NO
name	string	The name of country	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

Currency

GET /currency[/:currency_id]

Fields

Field	Type	Description	Required
id	string	The id of currency	NO
name	string	The name of currency	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /category[/:category_id]

Fields

Field	Type	Description	Required
id	string	The id of category	NO
name	string	The name of category	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

Agency

GET /agency

Fields

Field	Type	Description	Required
id	integer	The id of agency	NO
name	string	The name of agency	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /agency[/:agency_id]

Fields

Field	Type	Description	Required
id	integer	The id of agency	NO
name	string	The name of agency	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

Advertiser

GET /advertiser

Fields

Field	Type	Description	Required
id	integer	The id of advertiser	NO
name	string	The name of advertiser	YES
country	string	The country for the advertiser, refer to country service for a list of available country	YES
first_name	string	The first name of contact person	YES
last_name	string	The last name of contact person	NO
email	string	The email of contact person	YES
status		Advertiser status. Possible values: "active", "inactive", or "archived" (default: active)	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /advertiser[/:advertiser_id]

Fields

Field	Type	Description	Required
id	integer	The id of advertiser	NO
name	string	The name of advertiser	YES
country	string	The country for the advertiser, refer to country service for a list of available country	YES
first_name	string	The first name of contact person	YES
last_name	string	The last name of contact person	NO
email	string	The email of contact person	YES
status		Advertiser status. Possible values: "active", "inactive", or "archived" (default: active)	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

AdServer

GET /ad-server[/:ad_server_id]

Fields

Field	Type	Description	Required
zone_id	integer	This zone id will be referred when selecting ad list	YES
user_id	string	The unique id to identify the user	YES

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /ad

Fields

Field	Type	Description	Required
id	integer	The id of ad	NO
campaign_id	integer	ID of the campaign that this ad belongs to (Read Only)	NO
flight_id	integer	ID of the flight that this ad belongs to	YES
name	string	The name of ad	YES
ad_type_id	integer	The ad type id of this ad, please refer to AdType service. Ad type is only available on POST, not Patch	YES
ad_format_id	integer	The ad format id of this ad, please refer to AdFormat service. Ad format is only available on POST, not PATCH	YES
width	integer	The width of the ad (default:0)	NO
height	integer	The height of the ad (default:0)	NO
secondary_dimension	array	The secondary dimension for the ad, applicable and required on some ad format (eg. lightbox), example: array('full_width'=>900, 'full_height'=>500)	NO
start_date	string	Start date of the ad, example: "2015-01-01"	YES
end_date	string	End date of the ad, example: "2015-01-31"	YES
media_url	string	The URL of the ad - can be image, flash, zip. The URL must exist. This is required on POST when ad_type_id is (2) Image	NO
secondary_media_url	array	The URL of secondary media for the ad - can be image, flash, zip. The URL must exist. Applicable and required on some ad format (eg. lightbox), example: array('lightbox_media_url'=>'{string url}', 'backup_media_url'=>'{string url}')	NO
content	string	Javascript or HTML content. This is required on POST when ad_type_id is (4) Third Party HTML	NO
assets	string	Assets of the ad, encoded in JSON. This is required on POST when ad_type_id is (3) Text	NO
upload_status	string	Read-only. The status of the ad upload process. Possible values:"pending", "completed" or "failed"	NO
landing_url	string	The landing page URL	NO
segment_targets	array	DMP segment targeting, array of segments to be targeted, example: array(1,2)	NO
ad_option	array	Ad option, applicable and required on some ad format (eg. lightbox), example: array('alert_box'=>{boolean}, 'alert_message'=>{string}, 'background_opacity'=>{integer 0-100}, 'background-color'=>{string color code})	NO
status	string	The status of the ad. Possible values:"active" or "pause"	NO
geo_targets	array	Geo targeting, array of country to be targeted, example: array('MY', 'SG')	NO
capping	array	Frequency capping, all duration is in hour, example: array('cap'=>1, 'cap_duration'=>3, 'block'=>6, 'block_duration'=>24)	NO
time_targets	string	Time targeting for the ad. The string need to be in this format (comma separated value, each value consist of week day in 3 characters(Mon,Tue,Wed,Thu,Fri,Sat,Sun), an underscore, and the hour(0-23)), example: 'Mon_9,Mon_10,Tue_9,Tue_10'	NO
mobile_platform_targets	array	Mobile platform targeting, array of mobile platform to be targeted, example: array('Android', 'iPhone', 'iPad', 'BlackBerry', 'Windows Phone')	NO
mobile_platform_action	string	Action to be taken on the mobile_platform_targets list. Possible values:"include", "include_all" or "exclude_all"	NO
model_id	integer	Read-only. Flight serving model, refer to model service	NO
tracking_url	string	Third party impression tracking URL	NO
secondary_id	integer	Secondary id for engagement or view. On primary ad, this value will be -1, and on secondary ad, this value will be the primary ad id. Standard default single ad has value of 0 (Read Only)	NO
geo_action	string	Action to be taken on the geo_targets list. Possible values:"include", "include_all" or "exclude_all"	NO
browser_targets	array	Browser targeting, array of browser to be targeted, example: array('Edge', 'Firefox')	NO
browser_action	string	Action to be taken on the browser_targets list. Possible values:"include", "include_all" or "exclude_all"	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /ad

Fields

Field	Type	Description	Required
id	integer	The id of ad	NO
campaign_id	integer	ID of the campaign that this ad belongs to (Read Only)	NO
flight_id	integer	ID of the flight that this ad belongs to	YES
name	string	The name of ad	YES
ad_type_id	integer	The ad type id of this ad, please refer to AdType service. Ad type is only available on POST, not Patch	YES
ad_format_id	integer	The ad format id of this ad, please refer to AdFormat service. Ad format is only available on POST, not PATCH	YES
width	integer	The width of the ad (default:0)	NO
height	integer	The height of the ad (default:0)	NO
secondary_dimension	array	The secondary dimension for the ad, applicable and required on some ad format (eg. lightbox), example: array('full_width'=>900, 'full_height'=>500)	NO
start_date	string	Start date of the ad, example: "2015-01-01"	YES
end_date	string	End date of the ad, example: "2015-01-31"	YES
media_url	string	The URL of the ad - can be image, flash, zip. The URL must exist. This is required on POST when ad_type_id is (2) Image	NO
secondary_media_url	array	The URL of secondary media for the ad - can be image, flash, zip. The URL must exist. Applicable and required on some ad format (eg. lightbox), example: array('lightbox_media_url'=>'{string url}', 'backup_media_url'=>'{string url}')	NO
content	string	Javascript or HTML content. This is required on POST when ad_type_id is (4) Third Party HTML	NO
assets	string	Assets of the ad, encoded in JSON. This is required on POST when ad_type_id is (3) Text	NO
upload_status	string	Read-only. The status of the ad upload process. Possible values:"pending", "completed" or "failed"	NO
landing_url	string	The landing page URL	NO
segment_targets	array	DMP segment targeting, array of segments to be targeted, example: array(1,2)	NO
ad_option	array	Ad option, applicable and required on some ad format (eg. lightbox), example: array('alert_box'=>{boolean}, 'alert_message'=>{string}, 'background_opacity'=>{integer 0-100}, 'background-color'=>{string color code})	NO
status	string	The status of the ad. Possible values:"active" or "pause"	NO
geo_targets	array	Geo targeting, array of country to be targeted, example: array('MY', 'SG')	NO
capping	array	Frequency capping, all duration is in hour, example: array('cap'=>1, 'cap_duration'=>3, 'block'=>6, 'block_duration'=>24)	NO
time_targets	string	Time targeting for the ad. The string need to be in this format (comma separated value, each value consist of week day in 3 characters(Mon,Tue,Wed,Thu,Fri,Sat,Sun), an underscore, and the hour(0-23)), example: 'Mon_9,Mon_10,Tue_9,Tue_10'	NO
mobile_platform_targets	array	Mobile platform targeting, array of mobile platform to be targeted, example: array('Android', 'iPhone', 'iPad', 'BlackBerry', 'Windows Phone')	NO
mobile_platform_action	string	Action to be taken on the mobile_platform_targets list. Possible values:"include", "include_all" or "exclude_all"	NO
model_id	integer	Read-only. Flight serving model, refer to model service	NO
tracking_url	string	Third party impression tracking URL	NO
secondary_id	integer	Secondary id for engagement or view. On primary ad, this value will be -1, and on secondary ad, this value will be the primary ad id. Standard default single ad has value of 0 (Read Only)	NO
geo_action	string	Action to be taken on the geo_targets list. Possible values:"include", "include_all" or "exclude_all"	NO
browser_targets	array	Browser targeting, array of browser to be targeted, example: array('Edge', 'Firefox')	NO
browser_action	string	Action to be taken on the browser_targets list. Possible values:"include", "include_all" or "exclude_all"	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /ad[/:ad_id]

Fields

Field	Type	Description	Required
id	integer	The id of ad	NO
campaign_id	integer	ID of the campaign that this ad belongs to (Read Only)	NO
flight_id	integer	ID of the flight that this ad belongs to	YES
name	string	The name of ad	YES
ad_type_id	integer	The ad type id of this ad, please refer to AdType service. Ad type is only available on POST, not Patch	YES
ad_format_id	integer	The ad format id of this ad, please refer to AdFormat service. Ad format is only available on POST, not PATCH	YES
width	integer	The width of the ad (default:0)	NO
height	integer	The height of the ad (default:0)	NO
secondary_dimension	array	The secondary dimension for the ad, applicable and required on some ad format (eg. lightbox), example: array('full_width'=>900, 'full_height'=>500)	NO
start_date	string	Start date of the ad, example: "2015-01-01"	YES
end_date	string	End date of the ad, example: "2015-01-31"	YES
media_url	string	The URL of the ad - can be image, flash, zip. The URL must exist. This is required on POST when ad_type_id is (2) Image	NO
secondary_media_url	array	The URL of secondary media for the ad - can be image, flash, zip. The URL must exist. Applicable and required on some ad format (eg. lightbox), example: array('lightbox_media_url'=>'{string url}', 'backup_media_url'=>'{string url}')	NO
content	string	Javascript or HTML content. This is required on POST when ad_type_id is (4) Third Party HTML	NO
assets	string	Assets of the ad, encoded in JSON. This is required on POST when ad_type_id is (3) Text	NO
upload_status	string	Read-only. The status of the ad upload process. Possible values:"pending", "completed" or "failed"	NO
landing_url	string	The landing page URL	NO
segment_targets	array	DMP segment targeting, array of segments to be targeted, example: array(1,2)	NO
ad_option	array	Ad option, applicable and required on some ad format (eg. lightbox), example: array('alert_box'=>{boolean}, 'alert_message'=>{string}, 'background_opacity'=>{integer 0-100}, 'background-color'=>{string color code})	NO
status	string	The status of the ad. Possible values:"active" or "pause"	NO
geo_targets	array	Geo targeting, array of country to be targeted, example: array('MY', 'SG')	NO
capping	array	Frequency capping, all duration is in hour, example: array('cap'=>1, 'cap_duration'=>3, 'block'=>6, 'block_duration'=>24)	NO
time_targets	string	Time targeting for the ad. The string need to be in this format (comma separated value, each value consist of week day in 3 characters(Mon,Tue,Wed,Thu,Fri,Sat,Sun), an underscore, and the hour(0-23)), example: 'Mon_9,Mon_10,Tue_9,Tue_10'	NO
mobile_platform_targets	array	Mobile platform targeting, array of mobile platform to be targeted, example: array('Android', 'iPhone', 'iPad', 'BlackBerry', 'Windows Phone')	NO
mobile_platform_action	string	Action to be taken on the mobile_platform_targets list. Possible values:"include", "include_all" or "exclude_all"	NO
model_id	integer	Read-only. Flight serving model, refer to model service	NO
tracking_url	string	Third party impression tracking URL	NO
secondary_id	integer	Secondary id for engagement or view. On primary ad, this value will be -1, and on secondary ad, this value will be the primary ad id. Standard default single ad has value of 0 (Read Only)	NO
geo_action	string	Action to be taken on the geo_targets list. Possible values:"include", "include_all" or "exclude_all"	NO
browser_targets	array	Browser targeting, array of browser to be targeted, example: array('Edge', 'Firefox')	NO
browser_action	string	Action to be taken on the browser_targets list. Possible values:"include", "include_all" or "exclude_all"	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PATCH /ad[/:ad_id]

Fields

Field	Type	Description	Required
id	integer	The id of ad	NO
campaign_id	integer	ID of the campaign that this ad belongs to (Read Only)	NO
flight_id	integer	ID of the flight that this ad belongs to	YES
name	string	The name of ad	YES
ad_type_id	integer	The ad type id of this ad, please refer to AdType service. Ad type is only available on POST, not Patch	YES
ad_format_id	integer	The ad format id of this ad, please refer to AdFormat service. Ad format is only available on POST, not PATCH	YES
width	integer	The width of the ad (default:0)	NO
height	integer	The height of the ad (default:0)	NO
secondary_dimension	array	The secondary dimension for the ad, applicable and required on some ad format (eg. lightbox), example: array('full_width'=>900, 'full_height'=>500)	NO
start_date	string	Start date of the ad, example: "2015-01-01"	YES
end_date	string	End date of the ad, example: "2015-01-31"	YES
media_url	string	The URL of the ad - can be image, flash, zip. The URL must exist. This is required on POST when ad_type_id is (2) Image	NO
secondary_media_url	array	The URL of secondary media for the ad - can be image, flash, zip. The URL must exist. Applicable and required on some ad format (eg. lightbox), example: array('lightbox_media_url'=>'{string url}', 'backup_media_url'=>'{string url}')	NO
content	string	Javascript or HTML content. This is required on POST when ad_type_id is (4) Third Party HTML	NO
assets	string	Assets of the ad, encoded in JSON. This is required on POST when ad_type_id is (3) Text	NO
upload_status	string	Read-only. The status of the ad upload process. Possible values:"pending", "completed" or "failed"	NO
landing_url	string	The landing page URL	NO
segment_targets	array	DMP segment targeting, array of segments to be targeted, example: array(1,2)	NO
ad_option	array	Ad option, applicable and required on some ad format (eg. lightbox), example: array('alert_box'=>{boolean}, 'alert_message'=>{string}, 'background_opacity'=>{integer 0-100}, 'background-color'=>{string color code})	NO
status	string	The status of the ad. Possible values:"active" or "pause"	NO
geo_targets	array	Geo targeting, array of country to be targeted, example: array('MY', 'SG')	NO
capping	array	Frequency capping, all duration is in hour, example: array('cap'=>1, 'cap_duration'=>3, 'block'=>6, 'block_duration'=>24)	NO
time_targets	string	Time targeting for the ad. The string need to be in this format (comma separated value, each value consist of week day in 3 characters(Mon,Tue,Wed,Thu,Fri,Sat,Sun), an underscore, and the hour(0-23)), example: 'Mon_9,Mon_10,Tue_9,Tue_10'	NO
mobile_platform_targets	array	Mobile platform targeting, array of mobile platform to be targeted, example: array('Android', 'iPhone', 'iPad', 'BlackBerry', 'Windows Phone')	NO
mobile_platform_action	string	Action to be taken on the mobile_platform_targets list. Possible values:"include", "include_all" or "exclude_all"	NO
model_id	integer	Read-only. Flight serving model, refer to model service	NO
tracking_url	string	Third party impression tracking URL	NO
secondary_id	integer	Secondary id for engagement or view. On primary ad, this value will be -1, and on secondary ad, this value will be the primary ad id. Standard default single ad has value of 0 (Read Only)	NO
geo_action	string	Action to be taken on the geo_targets list. Possible values:"include", "include_all" or "exclude_all"	NO
browser_targets	array	Browser targeting, array of browser to be targeted, example: array('Edge', 'Firefox')	NO
browser_action	string	Action to be taken on the browser_targets list. Possible values:"include", "include_all" or "exclude_all"	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

Model

GET /model[/:model_id]

Fields

Field	Type	Description	Required
id	integer	The id of model	NO
name	string	The name of model	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

StatsServer

POST /stats-server[/:stats_server_id]

Fields

Field	Type	Description	Required
stats	Array	Stats to import in array of trackers, example: array(tracker_url1, tracker_url2, tracker_url3...)	YES

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PremiumPublisher

GET /premium-publisher[/:premium_publisher_id]

Fields

Field	Type	Description	Required
id	integer	The id of premium publisher	NO
name	string	The name of premium publisher	YES
country	string	The country for the premium publisher, refer to country service for a list of available country	YES

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PremiumSection

GET /premium-section[/:premium_section_id]

Fields

Field	Type	Description	Required
id	integer	The id of premium section	NO
premium_publisher_id	integer	ID of the premium publisher that this section belongs to	YES
name	string	The name of premium section	YES

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PremiumZone

GET /premium-zone[/:premium_zone_id]

Fields

Field	Type	Description	Required
id	integer	The id of premium zone	NO
premium_section_id	integer	ID of the premium section that this zone belongs to	YES
name	string	The name of premium zone	YES
url	string	The URL where the zone is placed	YES
width	integer	Width of the zone	YES
height	integer	Height of the zone	YES

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

Report

POST /report

Fields

Field	Type	Description	Required
id			NO
report_type	string	This determine which information will be returned, available type: "standard_analytics", "ad_network_detail", "rich_media", "rich_media_video"	YES
output_format	string	The report format in which the data will be returned, available format: "csv", "tsv" (default:"csv")	NO
filters	Array	The list of filter objects to apply to the report, available filters: campaign_id, flight_id, ad_id	NO
columns	Array	The list of columns to include in the report	NO
start_date	string	Start date of the report, example: "2015-01-01"	NO
end_date	string	End date of the report, example: "2015-01-31"	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /report[/:report_id]

Fields

Field	Type	Description	Required
id			NO
report_type	string	This determine which information will be returned, available type: "standard_analytics", "ad_network_detail", "rich_media", "rich_media_video"	YES
output_format	string	The report format in which the data will be returned, available format: "csv", "tsv" (default:"csv")	NO
filters	Array	The list of filter objects to apply to the report, available filters: campaign_id, flight_id, ad_id	NO
columns	Array	The list of columns to include in the report	NO
start_date	string	Start date of the report, example: "2015-01-01"	NO
end_date	string	End date of the report, example: "2015-01-31"	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

HouseAd

GET /house-ad

Fields

Field	Type	Description	Required
id	integer	The id of house Ad	NO
width	integer	width of the house ad	YES
height	integer	height of the house ad	YES
creative_id			YES
created_by			YES
country	string	The country for the house ad.	YES
channel_targeting	Array	The channels associated with this house ad. Refer to channel service for id.	NO
status	string	House ad status, Possible values: "active" or "inactive" (default: inactive)	YES

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /house-ad

Fields

Field	Type	Description	Required
id	integer	The id of house Ad	NO
width	integer	width of the house ad	YES
height	integer	height of the house ad	YES
creative_id			YES
created_by			YES
country	string	The country for the house ad.	YES
channel_targeting	Array	The channels associated with this house ad. Refer to channel service for id.	NO
status	string	House ad status, Possible values: "active" or "inactive" (default: inactive)	YES

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /house-ad[/:house_ad_id]

Fields

Field	Type	Description	Required
id	integer	The id of house Ad	NO
width	integer	width of the house ad	YES
height	integer	height of the house ad	YES
creative_id			YES
created_by			YES
country	string	The country for the house ad.	YES
channel_targeting	Array	The channels associated with this house ad. Refer to channel service for id.	NO
status	string	House ad status, Possible values: "active" or "inactive" (default: inactive)	YES

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PATCH /house-ad[/:house_ad_id]

Fields

Field	Type	Description	Required
id	integer	The id of house Ad	NO
width	integer	width of the house ad	YES
height	integer	height of the house ad	YES
creative_id			YES
created_by			YES
country	string	The country for the house ad.	YES
channel_targeting	Array	The channels associated with this house ad. Refer to channel service for id.	NO
status	string	House ad status, Possible values: "active" or "inactive" (default: inactive)	YES

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

AlternateAd

GET /alternate-ad

Fields

Field	Type	Description	Required
id	integer	The id of alternate ad	NO
smart_publisher_id	integer	The id of smart publisher	YES
name	string	The name of alternate ad	YES
width	integer	width of the alternate ad	YES
height	integer	height of the alternate ad	YES
type	string	The alternate ad type, Possible values: "html_template" .	YES
url	string	Web site full URL for alternate ad.	YES
status	string	The alternate ad status, Possible values: "active" or "inactive" (default:"active").	YES
ad_template	string	The ad template	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /alternate-ad

Fields

Field	Type	Description	Required
id	integer	The id of alternate ad	NO
smart_publisher_id	integer	The id of smart publisher	YES
name	string	The name of alternate ad	YES
width	integer	width of the alternate ad	YES
height	integer	height of the alternate ad	YES
type	string	The alternate ad type, Possible values: "html_template" .	YES
url	string	Web site full URL for alternate ad.	YES
status	string	The alternate ad status, Possible values: "active" or "inactive" (default:"active").	YES
ad_template	string	The ad template	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /alternate-ad[/:alternate_ad_id]

Fields

Field	Type	Description	Required
id	integer	The id of alternate ad	NO
smart_publisher_id	integer	The id of smart publisher	YES
name	string	The name of alternate ad	YES
width	integer	width of the alternate ad	YES
height	integer	height of the alternate ad	YES
type	string	The alternate ad type, Possible values: "html_template" .	YES
url	string	Web site full URL for alternate ad.	YES
status	string	The alternate ad status, Possible values: "active" or "inactive" (default:"active").	YES
ad_template	string	The ad template	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PATCH /alternate-ad[/:alternate_ad_id]

Fields

Field	Type	Description	Required
id	integer	The id of alternate ad	NO
smart_publisher_id	integer	The id of smart publisher	YES
name	string	The name of alternate ad	YES
width	integer	width of the alternate ad	YES
height	integer	height of the alternate ad	YES
type	string	The alternate ad type, Possible values: "html_template" .	YES
url	string	Web site full URL for alternate ad.	YES
status	string	The alternate ad status, Possible values: "active" or "inactive" (default:"active").	YES
ad_template	string	The ad template	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

AdType

GET /ad-type[/:ad_type_id]

Fields

Field	Type	Description	Required
id	integer	The id of ad type	NO
name	string	The ad type name	YES

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

AdFormat

GET /ad-format[/:ad_format_id]

Fields

Field	Type	Description	Required
id	integer	The id of ad format	NO
name	string	The ad format name	YES

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

DmpSegment

GET /dmp-segment[/:dmp_segment_id]

Fields

Field	Type	Description	Required
id	integer	The id of DMP segment	NO
name	string	The DMP segment name	YES
client_id	integer	The id of DMP client	YES
client_name	string	The DMP client name	YES
client_type	string	The DMP client type	YES
advertisers	array	The advertisers related to this DMP segment	NO
segment_type	string	The DMP segment type	NO
category	string	The DMP segment category	NO
definition_description	string	The DMP segment definition description	NO
total_audience	integer	Total audience of the dmp segment	NO
avg_imps	integer	Average impressions (last 30 days) of the DMP segment	NO
price	double	Price of this segment for marketplace, possible values: 0-1000000 (Read Only)	NO
marketplace	boolean	Availability of this segment on marketplace (Read Only)(default: false)	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

RichMedia

GET /rich-media

Fields

Field	Type	Description	Required
id	integer	The rich media id	NO
ad_id	integer	The ad id where this rich media is linked to	YES
event_name	string	The rich media event name, only alphabets(lowercase), numbers and underscore(_) allowed, must be unique within the ad. First character cannot be number or underscore, except for video event. Video event is added by this pattern ('_Video1', '_Video2', '_Video3'), start with underscore and end with number, and is case sensitive. Video event cannot be updated	YES
report_name	string	The rich media report name, this will be displayed in report	YES
interaction	boolean	Rich media counted as interaction, this is not available for video event (default: false)	NO
video_duration	integer	Video duration in seconds, only applicable to video rich media. Required when adding video event	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /rich-media

Fields

Field	Type	Description	Required
id	integer	The rich media id	NO
ad_id	integer	The ad id where this rich media is linked to	YES
event_name	string	The rich media event name, only alphabets(lowercase), numbers and underscore(_) allowed, must be unique within the ad. First character cannot be number or underscore, except for video event. Video event is added by this pattern ('_Video1', '_Video2', '_Video3'), start with underscore and end with number, and is case sensitive. Video event cannot be updated	YES
report_name	string	The rich media report name, this will be displayed in report	YES
interaction	boolean	Rich media counted as interaction, this is not available for video event (default: false)	NO
video_duration	integer	Video duration in seconds, only applicable to video rich media. Required when adding video event	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /rich-media[/:rich_media_id]

Fields

Field	Type	Description	Required
id	integer	The rich media id	NO
ad_id	integer	The ad id where this rich media is linked to	YES
event_name	string	The rich media event name, only alphabets(lowercase), numbers and underscore(_) allowed, must be unique within the ad. First character cannot be number or underscore, except for video event. Video event is added by this pattern ('_Video1', '_Video2', '_Video3'), start with underscore and end with number, and is case sensitive. Video event cannot be updated	YES
report_name	string	The rich media report name, this will be displayed in report	YES
interaction	boolean	Rich media counted as interaction, this is not available for video event (default: false)	NO
video_duration	integer	Video duration in seconds, only applicable to video rich media. Required when adding video event	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PATCH /rich-media[/:rich_media_id]

Fields

Field	Type	Description	Required
id	integer	The rich media id	NO
ad_id	integer	The ad id where this rich media is linked to	YES
event_name	string	The rich media event name, only alphabets(lowercase), numbers and underscore(_) allowed, must be unique within the ad. First character cannot be number or underscore, except for video event. Video event is added by this pattern ('_Video1', '_Video2', '_Video3'), start with underscore and end with number, and is case sensitive. Video event cannot be updated	YES
report_name	string	The rich media report name, this will be displayed in report	YES
interaction	boolean	Rich media counted as interaction, this is not available for video event (default: false)	NO
video_duration	integer	Video duration in seconds, only applicable to video rich media. Required when adding video event	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

DELETE /rich-media[/:rich_media_id]

Fields

Field	Type	Description	Required
id	integer	The rich media id	NO
ad_id	integer	The ad id where this rich media is linked to	YES
event_name	string	The rich media event name, only alphabets(lowercase), numbers and underscore(_) allowed, must be unique within the ad. First character cannot be number or underscore, except for video event. Video event is added by this pattern ('_Video1', '_Video2', '_Video3'), start with underscore and end with number, and is case sensitive. Video event cannot be updated	YES
report_name	string	The rich media report name, this will be displayed in report	YES
interaction	boolean	Rich media counted as interaction, this is not available for video event (default: false)	NO
video_duration	integer	Video duration in seconds, only applicable to video rich media. Required when adding video event	NO

Request

Headers

Header	Value
Accept	application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

SalesPrivilege

GET /sales-privilege[/:sales_privilege_id]

Fields

Field	Description	Required
user_id	User ID for permission privilege. (Read Only)	YES
view_group_campaign	Permission for user to view group campaign. Possible values: "true" or "false". (Read Only)	NO
view_regional_campaign	Permission for user to view regional campaign. Possible values: "true" or "false". (Read Only)	NO
view_my_campaign	Permission for user to view Malaysia campaign. Possible values: "true" or "false". (Read Only)	NO
view_sg_campaign	Permission for user to view Singapore campaign. Possible values: "true" or "false". (Read Only)	NO
view_th_campaign	Permission for user to view Thailand campaign. Possible values: "true" or "false". (Read Only)	NO
view_id_campaign	Permission for user to view Indonesia campaign. Possible values: "true" or "false". (Read Only)	NO
view_vn_campaign	Permission for user to view Vietnam campaign. Possible values: "true" or "false". (Read Only)	NO
view_ph_campaign	Permission for user to view Philippines campaign. Possible values: "true" or "false". (Read Only)	NO
view_hk_campaign	Permission for user to view Hong Kong campaign. Possible values: "true" or "false". (Read Only)	NO
view_tw_campaign	Permission for user to view Taiwan campaign. Possible values: "true" or "false". (Read Only)	NO
edit_sales_manager_campaign	Permission for user to edit sales manager campaign. Possible values: "true" or "false". (Read Only)	NO
edit_group_campaign	Permission for user to edit group campaign. Possible values: "true" or "false". (Read Only)	NO
edit_flight	Permission for user to edit flight. Possible values: "true" or "false". (Read Only)	NO
delete_campaign	Permission for user to delete campaign. Possible values: "true" or "false". (Read Only)	NO
delete_flight	Permission for user to delete flight. Possible values: "true" or "false". (Read Only)	NO
approve_campaign	Permission for user to approve campaign. Possible values: "true" or "false". (Read Only)	NO
verify_aio	Permission for user to verify aio. Possible values: "true" or "false". (Read Only)	NO
approve_flight_request	Permission for user to approve flight request. Possible values: "true" or "false". (Read Only)	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

CurrencyRate

POST /currency-rate[/:currency_rate_id]

Fields

Field	Type	Description	Required
from	string	From currency, 3 character currency code, example "USD"	YES
to	string	Tocurrency, 3 character currency code, example "USD"	YES
conversion_charges	string	This determine conversion charges to be included or excluded, available type: "include", "exclude", "none"	YES

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /currency-rate[/:currency_rate_id]

Fields

Field	Type	Description	Required
from	string	From currency, 3 character currency code, example "USD"	YES
to	string	Tocurrency, 3 character currency code, example "USD"	YES
conversion_charges	string	This determine conversion charges to be included or excluded, available type: "include", "exclude", "none"	YES

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

Creative

GET /creative

Fields

Field	Type	Description	Required
id	integer	The id of ad	NO
name	string	The name of ad	YES
flight_type_id	integer	ID of the flight type that this ad belongs to	YES
flight_platform_id	integer	ID of the flight platform that this ad belongs to	YES
ad_type_id	integer	The ad type id of this ad, please refer to AdType service. Ad type is only available on POST, not Patch	YES
ad_format_id	integer	The ad format id of this ad, please refer to AdFormat service. Ad format is only available on POST, not PATCH	YES
ad_size_id	integer	The ad size id of this ad	NO
status	string	The status of the ad. Possible values:"active" or "pause"	NO
width	integer	The width of the ad (default:0)	NO
height	integer	The height of the ad (default:0)	NO
media_url	array	The URL of media for the ad - can be image, flash, zip. The URL must exist. Applicable and required on some ad format (eg. lightbox), example: array('lightbox_media_url'=>'{string url}', 'backup_media_url'=>'{string url}')	NO
landing_url	string	The landing page URL	NO
capping_enable	string	The capping enable of the ad. Possible values:"Yes" or "No"	NO
capping	integer	Frequency capping, all duration is in hour	NO
capping_duration	integer	Frequency capping, all duration is in hour	NO
block	integer	Frequency capping, all duration is in hour	NO
block_duration	integer	Frequency capping, all duration is in hour	NO
geo_action	string	Action to be taken on the geo_targets list. Possible values:"include", "include_all" or "exclude_all"	NO
geo_targets	array	Geo targeting, array of country to be targeted, example: array('MY', 'SG')	NO
mobile_platform_action	string	Action to be taken on the mobile_platform_targets list. Possible values:"include", "include_all" or "exclude_all"	NO
mobile_platform_targets	array	Mobile platform targeting, array of mobile platform to be targeted, example: array('Android', 'iPhone', 'iPad', 'BlackBerry', 'Windows Phone')	NO
browser_action	string	Action to be taken on the browser_targets list. Possible values:"include", "include_all" or "exclude_all"	NO
browser_targets	array	Browser targeting, array of browser to be targeted, example: array('Edge', 'Firefox')	NO
segment_targets	array	DMP segment targeting, array of segments to be targeted, example: array(1,2)	NO
time_targets	string	Time targeting for the ad. The string need to be in this format (comma separated value, each value consist of week day in 3 characters(Mon,Tue,Wed,Thu,Fri,Sat,Sun), an underscore, and the hour(0-23)), example: 'Mon_9,Mon_10,Tue_9,Tue_10'	NO
show_innity_logo	integer	Show innity logo on the ad	NO
date	string	Date of the ad	NO
inview_tracking	string	Inview tracking for the ad	NO
imp_tracking_url	string	Third party impression tracking URL	NO
sec_tracker	integer	View tracker seconds of the ad	NO
opt_percent	integer	View tracker percentage of the ad	NO
clickable_bg	integer	Clickable background of the ad	NO
chk_UTF16Proxy	string	Encoding proxy of the ad. Possible values:"utf16" or "utf8"	NO
rad_DSPProxy	integer	Dsp proxy of the ad	NO
template	integer	Template of the ad	NO
language	string	Language of the ad. Possible value:"en", "zh-hant" and "zh-hans"	NO
video_player	integer	Video player of the ad	NO
mouseover_unmute	integer	Mouse over unmute for the ad	NO
bg_color	string	Background for the ad	NO
content	string	Javascript or HTML content. This is required on POST when ad_type_id is (4) Third Party HTML	NO
third_party_vendor	integer	ID for the third party vendor of the ad	NO
opacity	integer	Opacity of the background	NO
view_tracking_url	string	View tracking URL for the ad	NO
engagement_tracking_url	string	Engagement tracking URL for the ad	NO
custom_update	boolean	Custom update media	NO
uploaded_files			NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /creative

Fields

Field	Type	Description	Required
id	integer	The id of ad	NO
name	string	The name of ad	YES
flight_type_id	integer	ID of the flight type that this ad belongs to	YES
flight_platform_id	integer	ID of the flight platform that this ad belongs to	YES
ad_type_id	integer	The ad type id of this ad, please refer to AdType service. Ad type is only available on POST, not Patch	YES
ad_format_id	integer	The ad format id of this ad, please refer to AdFormat service. Ad format is only available on POST, not PATCH	YES
ad_size_id	integer	The ad size id of this ad	NO
status	string	The status of the ad. Possible values:"active" or "pause"	NO
width	integer	The width of the ad (default:0)	NO
height	integer	The height of the ad (default:0)	NO
media_url	array	The URL of media for the ad - can be image, flash, zip. The URL must exist. Applicable and required on some ad format (eg. lightbox), example: array('lightbox_media_url'=>'{string url}', 'backup_media_url'=>'{string url}')	NO
landing_url	string	The landing page URL	NO
capping_enable	string	The capping enable of the ad. Possible values:"Yes" or "No"	NO
capping	integer	Frequency capping, all duration is in hour	NO
capping_duration	integer	Frequency capping, all duration is in hour	NO
block	integer	Frequency capping, all duration is in hour	NO
block_duration	integer	Frequency capping, all duration is in hour	NO
geo_action	string	Action to be taken on the geo_targets list. Possible values:"include", "include_all" or "exclude_all"	NO
geo_targets	array	Geo targeting, array of country to be targeted, example: array('MY', 'SG')	NO
mobile_platform_action	string	Action to be taken on the mobile_platform_targets list. Possible values:"include", "include_all" or "exclude_all"	NO
mobile_platform_targets	array	Mobile platform targeting, array of mobile platform to be targeted, example: array('Android', 'iPhone', 'iPad', 'BlackBerry', 'Windows Phone')	NO
browser_action	string	Action to be taken on the browser_targets list. Possible values:"include", "include_all" or "exclude_all"	NO
browser_targets	array	Browser targeting, array of browser to be targeted, example: array('Edge', 'Firefox')	NO
segment_targets	array	DMP segment targeting, array of segments to be targeted, example: array(1,2)	NO
time_targets	string	Time targeting for the ad. The string need to be in this format (comma separated value, each value consist of week day in 3 characters(Mon,Tue,Wed,Thu,Fri,Sat,Sun), an underscore, and the hour(0-23)), example: 'Mon_9,Mon_10,Tue_9,Tue_10'	NO
show_innity_logo	integer	Show innity logo on the ad	NO
date	string	Date of the ad	NO
inview_tracking	string	Inview tracking for the ad	NO
imp_tracking_url	string	Third party impression tracking URL	NO
sec_tracker	integer	View tracker seconds of the ad	NO
opt_percent	integer	View tracker percentage of the ad	NO
clickable_bg	integer	Clickable background of the ad	NO
chk_UTF16Proxy	string	Encoding proxy of the ad. Possible values:"utf16" or "utf8"	NO
rad_DSPProxy	integer	Dsp proxy of the ad	NO
template	integer	Template of the ad	NO
language	string	Language of the ad. Possible value:"en", "zh-hant" and "zh-hans"	NO
video_player	integer	Video player of the ad	NO
mouseover_unmute	integer	Mouse over unmute for the ad	NO
bg_color	string	Background for the ad	NO
content	string	Javascript or HTML content. This is required on POST when ad_type_id is (4) Third Party HTML	NO
third_party_vendor	integer	ID for the third party vendor of the ad	NO
opacity	integer	Opacity of the background	NO
view_tracking_url	string	View tracking URL for the ad	NO
engagement_tracking_url	string	Engagement tracking URL for the ad	NO
custom_update	boolean	Custom update media	NO
uploaded_files			NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /creative[/:creative_id]

Fields

Field	Type	Description	Required
id	integer	The id of ad	NO
name	string	The name of ad	YES
flight_type_id	integer	ID of the flight type that this ad belongs to	YES
flight_platform_id	integer	ID of the flight platform that this ad belongs to	YES
ad_type_id	integer	The ad type id of this ad, please refer to AdType service. Ad type is only available on POST, not Patch	YES
ad_format_id	integer	The ad format id of this ad, please refer to AdFormat service. Ad format is only available on POST, not PATCH	YES
ad_size_id	integer	The ad size id of this ad	NO
status	string	The status of the ad. Possible values:"active" or "pause"	NO
width	integer	The width of the ad (default:0)	NO
height	integer	The height of the ad (default:0)	NO
media_url	array	The URL of media for the ad - can be image, flash, zip. The URL must exist. Applicable and required on some ad format (eg. lightbox), example: array('lightbox_media_url'=>'{string url}', 'backup_media_url'=>'{string url}')	NO
landing_url	string	The landing page URL	NO
capping_enable	string	The capping enable of the ad. Possible values:"Yes" or "No"	NO
capping	integer	Frequency capping, all duration is in hour	NO
capping_duration	integer	Frequency capping, all duration is in hour	NO
block	integer	Frequency capping, all duration is in hour	NO
block_duration	integer	Frequency capping, all duration is in hour	NO
geo_action	string	Action to be taken on the geo_targets list. Possible values:"include", "include_all" or "exclude_all"	NO
geo_targets	array	Geo targeting, array of country to be targeted, example: array('MY', 'SG')	NO
mobile_platform_action	string	Action to be taken on the mobile_platform_targets list. Possible values:"include", "include_all" or "exclude_all"	NO
mobile_platform_targets	array	Mobile platform targeting, array of mobile platform to be targeted, example: array('Android', 'iPhone', 'iPad', 'BlackBerry', 'Windows Phone')	NO
browser_action	string	Action to be taken on the browser_targets list. Possible values:"include", "include_all" or "exclude_all"	NO
browser_targets	array	Browser targeting, array of browser to be targeted, example: array('Edge', 'Firefox')	NO
segment_targets	array	DMP segment targeting, array of segments to be targeted, example: array(1,2)	NO
time_targets	string	Time targeting for the ad. The string need to be in this format (comma separated value, each value consist of week day in 3 characters(Mon,Tue,Wed,Thu,Fri,Sat,Sun), an underscore, and the hour(0-23)), example: 'Mon_9,Mon_10,Tue_9,Tue_10'	NO
show_innity_logo	integer	Show innity logo on the ad	NO
date	string	Date of the ad	NO
inview_tracking	string	Inview tracking for the ad	NO
imp_tracking_url	string	Third party impression tracking URL	NO
sec_tracker	integer	View tracker seconds of the ad	NO
opt_percent	integer	View tracker percentage of the ad	NO
clickable_bg	integer	Clickable background of the ad	NO
chk_UTF16Proxy	string	Encoding proxy of the ad. Possible values:"utf16" or "utf8"	NO
rad_DSPProxy	integer	Dsp proxy of the ad	NO
template	integer	Template of the ad	NO
language	string	Language of the ad. Possible value:"en", "zh-hant" and "zh-hans"	NO
video_player	integer	Video player of the ad	NO
mouseover_unmute	integer	Mouse over unmute for the ad	NO
bg_color	string	Background for the ad	NO
content	string	Javascript or HTML content. This is required on POST when ad_type_id is (4) Third Party HTML	NO
third_party_vendor	integer	ID for the third party vendor of the ad	NO
opacity	integer	Opacity of the background	NO
view_tracking_url	string	View tracking URL for the ad	NO
engagement_tracking_url	string	Engagement tracking URL for the ad	NO
custom_update	boolean	Custom update media	NO
uploaded_files			NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PATCH /creative[/:creative_id]

Fields

Field	Type	Description	Required
id	integer	The id of ad	NO
name	string	The name of ad	YES
flight_type_id	integer	ID of the flight type that this ad belongs to	YES
flight_platform_id	integer	ID of the flight platform that this ad belongs to	YES
ad_type_id	integer	The ad type id of this ad, please refer to AdType service. Ad type is only available on POST, not Patch	YES
ad_format_id	integer	The ad format id of this ad, please refer to AdFormat service. Ad format is only available on POST, not PATCH	YES
ad_size_id	integer	The ad size id of this ad	NO
status	string	The status of the ad. Possible values:"active" or "pause"	NO
width	integer	The width of the ad (default:0)	NO
height	integer	The height of the ad (default:0)	NO
media_url	array	The URL of media for the ad - can be image, flash, zip. The URL must exist. Applicable and required on some ad format (eg. lightbox), example: array('lightbox_media_url'=>'{string url}', 'backup_media_url'=>'{string url}')	NO
landing_url	string	The landing page URL	NO
capping_enable	string	The capping enable of the ad. Possible values:"Yes" or "No"	NO
capping	integer	Frequency capping, all duration is in hour	NO
capping_duration	integer	Frequency capping, all duration is in hour	NO
block	integer	Frequency capping, all duration is in hour	NO
block_duration	integer	Frequency capping, all duration is in hour	NO
geo_action	string	Action to be taken on the geo_targets list. Possible values:"include", "include_all" or "exclude_all"	NO
geo_targets	array	Geo targeting, array of country to be targeted, example: array('MY', 'SG')	NO
mobile_platform_action	string	Action to be taken on the mobile_platform_targets list. Possible values:"include", "include_all" or "exclude_all"	NO
mobile_platform_targets	array	Mobile platform targeting, array of mobile platform to be targeted, example: array('Android', 'iPhone', 'iPad', 'BlackBerry', 'Windows Phone')	NO
browser_action	string	Action to be taken on the browser_targets list. Possible values:"include", "include_all" or "exclude_all"	NO
browser_targets	array	Browser targeting, array of browser to be targeted, example: array('Edge', 'Firefox')	NO
segment_targets	array	DMP segment targeting, array of segments to be targeted, example: array(1,2)	NO
time_targets	string	Time targeting for the ad. The string need to be in this format (comma separated value, each value consist of week day in 3 characters(Mon,Tue,Wed,Thu,Fri,Sat,Sun), an underscore, and the hour(0-23)), example: 'Mon_9,Mon_10,Tue_9,Tue_10'	NO
show_innity_logo	integer	Show innity logo on the ad	NO
date	string	Date of the ad	NO
inview_tracking	string	Inview tracking for the ad	NO
imp_tracking_url	string	Third party impression tracking URL	NO
sec_tracker	integer	View tracker seconds of the ad	NO
opt_percent	integer	View tracker percentage of the ad	NO
clickable_bg	integer	Clickable background of the ad	NO
chk_UTF16Proxy	string	Encoding proxy of the ad. Possible values:"utf16" or "utf8"	NO
rad_DSPProxy	integer	Dsp proxy of the ad	NO
template	integer	Template of the ad	NO
language	string	Language of the ad. Possible value:"en", "zh-hant" and "zh-hans"	NO
video_player	integer	Video player of the ad	NO
mouseover_unmute	integer	Mouse over unmute for the ad	NO
bg_color	string	Background for the ad	NO
content	string	Javascript or HTML content. This is required on POST when ad_type_id is (4) Third Party HTML	NO
third_party_vendor	integer	ID for the third party vendor of the ad	NO
opacity	integer	Opacity of the background	NO
view_tracking_url	string	View tracking URL for the ad	NO
engagement_tracking_url	string	Engagement tracking URL for the ad	NO
custom_update	boolean	Custom update media	NO
uploaded_files			NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

ThirdPartyVendor

GET /third-party-vendor[/:third_party_vendor_id]

Fields

Field	Type	Description	Required
id	integer	The id of third party vendor	NO
name	string	The name of the third party vendor	YES

Request

Headers

Header	Value
Accept	application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

AmendmentRequest

GET /amendment-request

Fields

Field	Type	Description	Required
id	integer	The id of amendment request	NO
request_type	string	The type of amendment request, possible values: "flight_costing", "pending_flight", "delete_flight", "campaign_approval", "campaign_aio"	NO
status	string	The status of amendment request. Possible values: "pending", or "completed"	NO
campaign_id	integer	The id of campaign	NO
flight_id	integer	The id of flight	NO
request_user_id	integer	The user id of requestor	NO
created_on	string	The time of amendment request was created	NO
reason	string	The reason the amendment request	NO
item_update	array	The items to be updated for flight costing request	NO
action	string	The action of amendment request. Possible values: "approve", or "reject"	NO
remark	string	The remarks of amendment request action. This is used when approve or reject the request	NO
pending_flight_name	string	The name of pending flight	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /amendment-request[/:amendment_request_id]

Fields

Field	Type	Description	Required
id	integer	The id of amendment request	NO
request_type	string	The type of amendment request, possible values: "flight_costing", "pending_flight", "delete_flight", "campaign_approval", "campaign_aio"	NO
status	string	The status of amendment request. Possible values: "pending", or "completed"	NO
campaign_id	integer	The id of campaign	NO
flight_id	integer	The id of flight	NO
request_user_id	integer	The user id of requestor	NO
created_on	string	The time of amendment request was created	NO
reason	string	The reason the amendment request	NO
item_update	array	The items to be updated for flight costing request	NO
action	string	The action of amendment request. Possible values: "approve", or "reject"	NO
remark	string	The remarks of amendment request action. This is used when approve or reject the request	NO
pending_flight_name	string	The name of pending flight	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PATCH /amendment-request[/:amendment_request_id]

Fields

Field	Type	Description	Required
id	integer	The id of amendment request	NO
request_type	string	The type of amendment request, possible values: "flight_costing", "pending_flight", "delete_flight", "campaign_approval", "campaign_aio"	NO
status	string	The status of amendment request. Possible values: "pending", or "completed"	NO
campaign_id	integer	The id of campaign	NO
flight_id	integer	The id of flight	NO
request_user_id	integer	The user id of requestor	NO
created_on	string	The time of amendment request was created	NO
reason	string	The reason the amendment request	NO
item_update	array	The items to be updated for flight costing request	NO
action	string	The action of amendment request. Possible values: "approve", or "reject"	NO
remark	string	The remarks of amendment request action. This is used when approve or reject the request	NO
pending_flight_name	string	The name of pending flight	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PendingFlight

GET /pending-flight

Fields

Field	Type	Description	Required
id	integer	The id of flight	NO
campaign_id	integer	ID of the campaign that this flight belongs to	YES
name	string	The name of flight	YES
flight_type	string	The flight type is only available on POST and not in PATCH, changing flight type is not available. Possible values: "premium" - served in specific premium publisher, "performance" - served in ad network channels	YES
platform	string	The platform is only available on POST and not in PATCH, changing platform is not available. Possible values: "web" - for deskktop, "mobile" - for mobile, "wifi" - for wifi. (Read Only)	NO
channels	Array	The channels associated with this flight. Refer to channel service. Required if flight_type is "performance"	NO
zone_id	integer	The zone id associated with this flight. Required if flight_type is "premium"	NO
start_date	string	Start date of the flight, example: "2015-01-01"	YES
end_date	string	End date of the campaign, example: "2015-01-31"	YES
full_date			NO
model_id	integer	Flight serving model, refer to model service	YES
inventory	integer	Total inventory of the flight, possible values: 1-100000000, and -1 as unlimited	YES
value_added			NO
base_media_cost	double	Base media cost of a single unit, possible values: 0-1000000, if this is not passed in, the value of media cost will be copied over	NO
media_cost	double	Media cost of a single unit, possible values: 0-1000000	YES
discount	double	Discount on flight cost, possible values: 0-100	NO
agency_commission	double	Agency commission, possible values: 0-100	NO
innity_commission	double	Innity commission, possible values: 0-100	NO
cost_after_discount	integer	. (Read Only)	NO
total_cost_after_discount	integer	. (Read Only)	NO
cost_after_agency_commission	integer	. (Read Only)	NO
cost_after_commission	integer	. (Read Only)	NO
rich_media_casual_cost	integer	. (Read Only)	NO
rich_media_discount	integer	. (Read Only)	NO
rich_media_cost_after_discount	integer	. (Read Only)	NO
rich_media_total_cost_after_discount	integer	. (Read Only)	NO
rich_media_cost_after_agency_commission	integer	. (Read Only)	NO
rich_media_cost_after_commission	integer	. (Read Only)	NO
rich_media_agency_commission	integer	. (Read Only)	NO
rich_media_commission	integer	. (Read Only)	NO
remarks	string	Remarks for the flight (Read Only)	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /pending-flight[/:pending_flight_id]

Fields

Field	Type	Description	Required
id	integer	The id of flight	NO
campaign_id	integer	ID of the campaign that this flight belongs to	YES
name	string	The name of flight	YES
flight_type	string	The flight type is only available on POST and not in PATCH, changing flight type is not available. Possible values: "premium" - served in specific premium publisher, "performance" - served in ad network channels	YES
platform	string	The platform is only available on POST and not in PATCH, changing platform is not available. Possible values: "web" - for deskktop, "mobile" - for mobile, "wifi" - for wifi. (Read Only)	NO
channels	Array	The channels associated with this flight. Refer to channel service. Required if flight_type is "performance"	NO
zone_id	integer	The zone id associated with this flight. Required if flight_type is "premium"	NO
start_date	string	Start date of the flight, example: "2015-01-01"	YES
end_date	string	End date of the campaign, example: "2015-01-31"	YES
full_date			NO
model_id	integer	Flight serving model, refer to model service	YES
inventory	integer	Total inventory of the flight, possible values: 1-100000000, and -1 as unlimited	YES
value_added			NO
base_media_cost	double	Base media cost of a single unit, possible values: 0-1000000, if this is not passed in, the value of media cost will be copied over	NO
media_cost	double	Media cost of a single unit, possible values: 0-1000000	YES
discount	double	Discount on flight cost, possible values: 0-100	NO
agency_commission	double	Agency commission, possible values: 0-100	NO
innity_commission	double	Innity commission, possible values: 0-100	NO
cost_after_discount	integer	. (Read Only)	NO
total_cost_after_discount	integer	. (Read Only)	NO
cost_after_agency_commission	integer	. (Read Only)	NO
cost_after_commission	integer	. (Read Only)	NO
rich_media_casual_cost	integer	. (Read Only)	NO
rich_media_discount	integer	. (Read Only)	NO
rich_media_cost_after_discount	integer	. (Read Only)	NO
rich_media_total_cost_after_discount	integer	. (Read Only)	NO
rich_media_cost_after_agency_commission	integer	. (Read Only)	NO
rich_media_cost_after_commission	integer	. (Read Only)	NO
rich_media_agency_commission	integer	. (Read Only)	NO
rich_media_commission	integer	. (Read Only)	NO
remarks	string	Remarks for the flight (Read Only)	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

ServingCampaign

GET /serving-campaign[/:serving_campaign_id]

Fields

Field	Type	Description	Required
opt	mixed	Option for the results, possible values: 'all'(default), 'engagement'(return only engagement flights), 'cpm'(return particular model flights, multiple values supported using comma separator)	NO
country	string	Campaign country filter	NO
advertiser_id	integer	Campaign advertiser filter	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

Conversion

GET /conversion

Fields

Field	Type	Description	Required
id	integer	The id of conversion	NO
name	string	The name of conversion	YES
advertiser_id	integer	The advertiser id associated with this conversion. Refer to advertiser service	YES
conversion_type	string	Conversion type, if set to standard, the conversion will be used for costing calculation. If conversion type is set to activity, it will only be used in reports but not costing. Possible values: "standard", "activity" (default:"standard")	YES
campaign_id	array	The campaigns that is linked to this conversion, example: array(1,2)	NO
tag	string	The tag of this conversion (Read Only)	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /conversion

Fields

Field	Type	Description	Required
id	integer	The id of conversion	NO
name	string	The name of conversion	YES
advertiser_id	integer	The advertiser id associated with this conversion. Refer to advertiser service	YES
conversion_type	string	Conversion type, if set to standard, the conversion will be used for costing calculation. If conversion type is set to activity, it will only be used in reports but not costing. Possible values: "standard", "activity" (default:"standard")	YES
campaign_id	array	The campaigns that is linked to this conversion, example: array(1,2)	NO
tag	string	The tag of this conversion (Read Only)	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /conversion[/:conversion_id]

Fields

Field	Type	Description	Required
id	integer	The id of conversion	NO
name	string	The name of conversion	YES
advertiser_id	integer	The advertiser id associated with this conversion. Refer to advertiser service	YES
conversion_type	string	Conversion type, if set to standard, the conversion will be used for costing calculation. If conversion type is set to activity, it will only be used in reports but not costing. Possible values: "standard", "activity" (default:"standard")	YES
campaign_id	array	The campaigns that is linked to this conversion, example: array(1,2)	NO
tag	string	The tag of this conversion (Read Only)	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PATCH /conversion[/:conversion_id]

Fields

Field	Type	Description	Required
id	integer	The id of conversion	NO
name	string	The name of conversion	YES
advertiser_id	integer	The advertiser id associated with this conversion. Refer to advertiser service	YES
conversion_type	string	Conversion type, if set to standard, the conversion will be used for costing calculation. If conversion type is set to activity, it will only be used in reports but not costing. Possible values: "standard", "activity" (default:"standard")	YES
campaign_id	array	The campaigns that is linked to this conversion, example: array(1,2)	NO
tag	string	The tag of this conversion (Read Only)	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PassionationFlight

GET /passionation-flight

Fields

Field	Type	Description	Required
id	integer	The id of flight	NO
campaign_id	integer	The id of campaign	NO
name	string	The name of campaign	YES
product	string	The name of product	YES
category_id	string	Campaign category id, example: "2_25". Refer to category service	YES
advertiser_id	integer	The advertiser id associated with this campaign. Refer to advertiser service	YES
advertiser_name	string	The name of advertiser	NO
country	string	The country for the campaign, refer to country service for a list of available country	YES
currency	string	Currency used on the campaign, example: "MYR". Refer to currency service for a list of available currency (default: according to country's currency)	NO
start_date	string	Start date of the flight, example: "2015-01-01"	YES
end_date	string	End date of the campaign, example: "2015-01-31"	YES
unit_cost	double	Unit cost of a single unit, possible values: 0-1000000	YES
inventory	integer	Total inventory of the flight, possible values: 1-100000000	YES
total_sales	double	Total sales of the flight (Read Only)	NO
total_cost	double	Total cost of the flight (Read Only)	NO
pay_by_coins	boolean	To determine if the flight is pay by coins (Read Only)	NO
total_coins_payout	integer	Total coins to payout (Read Only)	NO
last_updated	string	Last updated timestamp (Read Only)	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /passionation-flight[/:passionation_flight_id]

Fields

Field	Type	Description	Required
id	integer	The id of flight	NO
campaign_id	integer	The id of campaign	NO
name	string	The name of campaign	YES
product	string	The name of product	YES
category_id	string	Campaign category id, example: "2_25". Refer to category service	YES
advertiser_id	integer	The advertiser id associated with this campaign. Refer to advertiser service	YES
advertiser_name	string	The name of advertiser	NO
country	string	The country for the campaign, refer to country service for a list of available country	YES
currency	string	Currency used on the campaign, example: "MYR". Refer to currency service for a list of available currency (default: according to country's currency)	NO
start_date	string	Start date of the flight, example: "2015-01-01"	YES
end_date	string	End date of the campaign, example: "2015-01-31"	YES
unit_cost	double	Unit cost of a single unit, possible values: 0-1000000	YES
inventory	integer	Total inventory of the flight, possible values: 1-100000000	YES
total_sales	double	Total sales of the flight (Read Only)	NO
total_cost	double	Total cost of the flight (Read Only)	NO
pay_by_coins	boolean	To determine if the flight is pay by coins (Read Only)	NO
total_coins_payout	integer	Total coins to payout (Read Only)	NO
last_updated	string	Last updated timestamp (Read Only)	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

Seeder

GET /seeder

Fields

Field	Type	Description	Required
id	integer	The id of seeder	NO
firstname	string	The first name of seeder	YES
lastname	string	The last name of seeder	NO
email	string	The email of seeder	YES
gender	string	Gender used on the seeder, possible values: "male", "female". (default: male)	NO
contact_no	string	The number of contact	NO
address	string	The address of seeder	NO
country	string	The country of seeder in country code	YES
currency	string	Currency used on the seeder, example: "MYR". Refer to currency service for a list of available currency	YES
company_name	string	The company name of seeder	NO
payment_preference	string	The payment preference of seeder	NO
bank_name	string	The bank name of seeder	NO
account_name	string	the account name of seeder	NO
tax	float	the tax amount of seeder	NO
sst_id	string	the sst id of seeder	NO
account_number	string	The account number of seeder	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /seeder

Fields

Field	Type	Description	Required
id	integer	The id of seeder	NO
firstname	string	The first name of seeder	YES
lastname	string	The last name of seeder	NO
email	string	The email of seeder	YES
gender	string	Gender used on the seeder, possible values: "male", "female". (default: male)	NO
contact_no	string	The number of contact	NO
address	string	The address of seeder	NO
country	string	The country of seeder in country code	YES
currency	string	Currency used on the seeder, example: "MYR". Refer to currency service for a list of available currency	YES
company_name	string	The company name of seeder	NO
payment_preference	string	The payment preference of seeder	NO
bank_name	string	The bank name of seeder	NO
account_name	string	the account name of seeder	NO
tax	float	the tax amount of seeder	NO
sst_id	string	the sst id of seeder	NO
account_number	string	The account number of seeder	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /seeder[/:seeder_id]

Fields

Field	Type	Description	Required
id	integer	The id of seeder	NO
firstname	string	The first name of seeder	YES
lastname	string	The last name of seeder	NO
email	string	The email of seeder	YES
gender	string	Gender used on the seeder, possible values: "male", "female". (default: male)	NO
contact_no	string	The number of contact	NO
address	string	The address of seeder	NO
country	string	The country of seeder in country code	YES
currency	string	Currency used on the seeder, example: "MYR". Refer to currency service for a list of available currency	YES
company_name	string	The company name of seeder	NO
payment_preference	string	The payment preference of seeder	NO
bank_name	string	The bank name of seeder	NO
account_name	string	the account name of seeder	NO
tax	float	the tax amount of seeder	NO
sst_id	string	the sst id of seeder	NO
account_number	string	The account number of seeder	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PATCH /seeder[/:seeder_id]

Fields

Field	Type	Description	Required
id	integer	The id of seeder	NO
firstname	string	The first name of seeder	YES
lastname	string	The last name of seeder	NO
email	string	The email of seeder	YES
gender	string	Gender used on the seeder, possible values: "male", "female". (default: male)	NO
contact_no	string	The number of contact	NO
address	string	The address of seeder	NO
country	string	The country of seeder in country code	YES
currency	string	Currency used on the seeder, example: "MYR". Refer to currency service for a list of available currency	YES
company_name	string	The company name of seeder	NO
payment_preference	string	The payment preference of seeder	NO
bank_name	string	The bank name of seeder	NO
account_name	string	the account name of seeder	NO
tax	float	the tax amount of seeder	NO
sst_id	string	the sst id of seeder	NO
account_number	string	The account number of seeder	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

FraudExemption

GET /fraud-exemption[/:fraud_exemption_id]

Fields

Field	Description	Required
ad_id		NO
exemption_type	Fraud rule to skip, eg: empty_imp_id	NO
description	The reason to skip fraud rule	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

SeederPayment

GET /seeder-payment

Fields

Field	Type	Description	Required
id	integer	The id of seeder payment	NO
seeder_id	integer	The id of seeder	YES
flight_id	integer	The id of flight	YES
amount	float	The nett amount to be paid to seeder, based on the flight currency, possible values: 0-1000000	YES
converted_amount	float	The nett amount to be paid to seeder, converted to the seeder currency	NO
post_date	string	Post date for the seeder earnings, example: "2019-01-01"	YES
unit_cost	float	Unit cost of a single unit, possible values: 0-1000000	YES
payment_status	string	Payment status, Possible values: "pending" or "paid"	NO
payment_date	string	The date where the payment is made to seeder, example: "2019-01-01"	NO
post_screenshot	array	Screenshot of the seeder post, finance require this for audit purposes, example: array('path/to/image1.png', 'path/to/image2.png')	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /seeder-payment

Fields

Field	Type	Description	Required
id	integer	The id of seeder payment	NO
seeder_id	integer	The id of seeder	YES
flight_id	integer	The id of flight	YES
amount	float	The nett amount to be paid to seeder, based on the flight currency, possible values: 0-1000000	YES
converted_amount	float	The nett amount to be paid to seeder, converted to the seeder currency	NO
post_date	string	Post date for the seeder earnings, example: "2019-01-01"	YES
unit_cost	float	Unit cost of a single unit, possible values: 0-1000000	YES
payment_status	string	Payment status, Possible values: "pending" or "paid"	NO
payment_date	string	The date where the payment is made to seeder, example: "2019-01-01"	NO
post_screenshot	array	Screenshot of the seeder post, finance require this for audit purposes, example: array('path/to/image1.png', 'path/to/image2.png')	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /seeder-payment[/:seeder_payment_id]

Fields

Field	Type	Description	Required
id	integer	The id of seeder payment	NO
seeder_id	integer	The id of seeder	YES
flight_id	integer	The id of flight	YES
amount	float	The nett amount to be paid to seeder, based on the flight currency, possible values: 0-1000000	YES
converted_amount	float	The nett amount to be paid to seeder, converted to the seeder currency	NO
post_date	string	Post date for the seeder earnings, example: "2019-01-01"	YES
unit_cost	float	Unit cost of a single unit, possible values: 0-1000000	YES
payment_status	string	Payment status, Possible values: "pending" or "paid"	NO
payment_date	string	The date where the payment is made to seeder, example: "2019-01-01"	NO
post_screenshot	array	Screenshot of the seeder post, finance require this for audit purposes, example: array('path/to/image1.png', 'path/to/image2.png')	NO

Request

Headers

Header	Value
Accept	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PATCH /seeder-payment[/:seeder_payment_id]

Fields

Field	Type	Description	Required
id	integer	The id of seeder payment	NO
seeder_id	integer	The id of seeder	YES
flight_id	integer	The id of flight	YES
amount	float	The nett amount to be paid to seeder, based on the flight currency, possible values: 0-1000000	YES
converted_amount	float	The nett amount to be paid to seeder, converted to the seeder currency	NO
post_date	string	Post date for the seeder earnings, example: "2019-01-01"	YES
unit_cost	float	Unit cost of a single unit, possible values: 0-1000000	YES
payment_status	string	Payment status, Possible values: "pending" or "paid"	NO
payment_date	string	The date where the payment is made to seeder, example: "2019-01-01"	NO
post_screenshot	array	Screenshot of the seeder post, finance require this for audit purposes, example: array('path/to/image1.png', 'path/to/image2.png')	NO

Request

Headers

Header	Value
Accept	application/json
Content-Type	application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

sample

GET /sample

Request

Headers

Header	Value
Accept	application/vnd.advenue.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/vnd.advenue.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /sample

Request

Headers

Header	Value
Accept	application/vnd.advenue.v1+json application/hal+json application/json
Content-Type	application/vnd.advenue.v1+json application/json

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created

Headers

Header	Value
Content-Type	application/vnd.advenue.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /sample[/:sample_id]

Request

Headers

Header	Value
Accept	application/vnd.advenue.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.advenue.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PATCH /sample[/:sample_id]

Request

Headers

Header	Value
Accept	application/vnd.advenue.v1+json application/hal+json application/json
Content-Type	application/vnd.advenue.v1+json application/json

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.advenue.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PUT /sample[/:sample_id]

Request

Headers

Header	Value
Accept	application/vnd.advenue.v1+json application/hal+json application/json
Content-Type	application/vnd.advenue.v1+json application/json

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.advenue.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

DELETE /sample[/:sample_id]

Request

Headers

Header	Value
Accept	application/vnd.advenue.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.advenue.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Documentation

Advenue (v1)

SmartPublisher

GET /smart-publisher

Fields

Request

Headers

Response

Status Codes

Headers

Body

POST /smart-publisher

Fields

Request

Headers

Body

Response

Status Codes

Headers

Body

GET /smart-publisher[/:smart_publisher_id]

Fields

Request

Headers

Response

Status Codes

Headers

Body

PATCH /smart-publisher[/:smart_publisher_id]

Fields

Request

Headers

Body

Response

Status Codes

Headers

Body

User

GET /user

Fields

Request

Headers

Response

Status Codes

Headers

Body

POST /user

Fields

Request

Headers

Body

Response

Status Codes

Headers

Body

GET /user[/:user_id]

Fields

Request

Headers

Response

Status Codes

Headers

Body

PATCH /user[/:user_id]

Fields

Request

Headers

Body

Response

Status Codes

Headers

Body

Site

GET /site

Fields

Request

Headers

Response

Status Codes

Headers