Create/Update Advertiser

Creates or updates advertiser info based on whether or not ID was provided.

URL: /rest-api/advertisers/update.do
Method: PUT
Response format: application/json

Error codes:

401 Unauthorized – authentication error.

Response sample:
200 OK
{"success":true, id:} – success, returns id of affected advertiser record.
{"success":false} – error {"success":false, "error":"permission_denied"} – error due to insufficient privileges.

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • id – identifier of the Advertiser that will be updated (optional, if no value is provided, new Advertiser will be created).
  • name – advertiser name (optional).
  • contactName – advertiser contact name (optional).
  • contactEmail – advertiser contact e–mail (optional).
  • description – advertiser description (optional).
  • categoryId – advertiser category (optional).
  • active – Active status identifier; true/false.

Delete Advertiser

Deletes advertiser by given ID.

URL: /rest-api/advertisers/{advertiserId}/delete.do
Method: DELETE
Response format: application/json

Error codes:

401 Unauthorized – authentication error.

Response sample:
200 OK
{"success":true} – success
{"permission_denied":,"success":false} – failure due to insufficient privileges

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.

Get Advertiser

Get Advertiser information by given ID.

URL: /rest-api/advertisers/{advertiserId}.do
Method: GET
Response format: application/json

Error codes:

401 Unauthorized – authentication error.

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • categoryId – Advertiser categories (optional).

Get Campaigns For Advertiser

Get the list of all Campaigns for a given Advertiser.

URL: /rest-api/advertiser/{advertiserId}/campaigns.do
Method: GET
Response format: application/json

Error codes:

401 Unauthorized – authentication error.

Response sample:
200 OK
[{"id":1, "name":"campaign1"}, ...]

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.

Get Advertiser Permissions For User

Get all Advertiser Shares for User with Access Level information: Can Edit/Can View/Is Owner.

URL: /rest-api/advertiserShares.do
Method: GET
Response format: application/json

Error codes:

401 Unauthorized – authentication error.

Response sample:
200 OK
[{"id":1, "name":"campaign1"}, ...]

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.

Get Advertising Categories

Receive the list of all available Advertising Categories.

URL: /rest-api/categories/advertising.do
Method: GET
Response format: application/json

Error codes:

401 Unauthorized – authentication error.

Response sample:
200 OK
{"success":true, id:} – success, returns id of affected advertiser record.
{"success":false} – error {"success":false, "error":"permission_denied"} – error due to insufficient permissions.

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.

Get All Advertisers

Get the list of all Advertisers for the given user account.

URL: /rest-api/advertisers.do
Method: GET
Response format: application/json

Error codes:

401 Unauthorized – authentication error.

Response sample:
200 OK
[{"id":1,"name":"First Advertiser"},{"id":2,"name":"Second Advertiser"}, ...]

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • advertisingCategories - IDs of Inventory Categories to group the result (optional).

Get Security Settings for Advertiser

Get security settings for the Advertiser with given ID.

URL: /rest-api/security-settings/advertiser.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • id – advertiser ID.

Update Security Settings for Advertiser

Update Security Settings for the Advertiser with given ID.

URL: /rest-api/security-settings/advertiser/save.do
Method: POST
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.

Response sample:
200 OK
{ "success" : true }

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • id – advertiser ID.
  • mediaScannerOn – (required) enable/disable media scanner settings; boolean.
  • mediaScannerStartDate – (required) start date for media scanner in yyyy-MM-dd format.
  • mediaScannerEndDate – (required) end date for media scanner in yyyy-MM-dd format.
  • mediaScannerRate – (required) media scanner rate.
  • forensiqOn – (required) enable/disable forensiq; boolean.
  • countries – (optional) array of country codes.
  • adEvents – (optional) array of ad events to set. Available values: REQUEST, IMPRESSION, CLICK, ACTION.
  • dateFrom – (required) start date for forensiq in yyyy-MM-dd format.
  • dateTo – (required) end date for forensiq in yyyy-MM-dd format.
  • trafficQualityFiltering – (required) traffic quality filtering. Available values: ACCEPT_ALL, REJECT_HIGH_RISK, REJECT_SUSPICIOUS or REJECT_CUSTOM.
  • trafficShare – (required) traffic share as a double.
  • trafficQualityMaxRisk – (required) traffic share as integer.

Disable Security Settings for Advertiser

Disables all security settings for the Advertiser with given ID.

URL: /rest-api/security-settings/advertiser/disable.do
Method: POST
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.

Response sample:
200 OK
{ "success": true }

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • id – advertiser ID.

Need more help?

Should you require any additional help with our solutions, do not hesitate to contact Epom technical support at support@epom.com. Our support managers are dedicated to resolving any issues and providing you with solutions and support if you face difficulties or have questions.