Set Limits

Set the Advertiser Limits by advertiser ID.

URL: /rest-api/advertiser/{advertiserId}/limits/set.do
Method: POST
Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. No Advertiser with the given Advertiser ID.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Request Parameters:

  • startDate – limit start, "yyyy–MM–dd–HH–mm".
  • endDate – limit end, "yyyy–MM–dd–HH–mm".
  • useLocalTime - value for using the Local Time for the Date & Time Limits, true/false.
  • timezoneOffset - sets the user's timezone offset in minutes; integer. Required if useLocalTime value is set to true. To get user's timezone, run the following JS code: new Date().getTimezoneOffset()/-1
  • evenPacing – value for Even Pacing option; true/false.
  • totalImpressionsLimit – limit for impressions.
  • totalClicksLimit – limit for clicks.
  • totalBudgetLimit – limit for budget.
  • dailyImpressionsLimit – daily limit for impressions.
  • dailyClicksLimit – daily limit for clicks.
  • dailyBudgetLimit – daily limit for budget.
  • totalImpressions – current impressions.
  • totalClicks – current clicks.
  • totalBudget – current budget.
  • dailyImpressions – impressions for current day.
  • dailyClicks – clicks for current day.
  • dailyBudget – budget for current day.

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.
  • advertiserId – the given Advertiser ID.

Get Limits

Get the Advertiser Limits information by Advertiser ID.

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

Error codes:

  • 400 Bad Request – wrong request format. No Advertiser with the given Advertiser ID.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Limits not enabled or Advertiser not found.

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.
  • advertiserId – the given Advertiser ID.

Update Limits

Updates the Advertiser Limits information by Advertiser ID.

URL: /rest-api/advertiser/{advertiserId}/limits/update.do
Method: POST
Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. No Advertiser with the given Advertiser ID.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Limits not enabled or Advertiser not found.

Request Parameters:

  • startDate – limit start, "yyyy–MM–dd–HH–mm".
  • endDate – limit end, "yyyy–MM–dd–HH–mm".
  • totalImpressionsLimit – limit for impressions.
  • totalClicksLimit – limit for clicks.
  • totalBudgetLimit – limit for budget.
  • dailyImpressionsLimit – daily limit for impressions.
  • dailyClicksLimit – daily limit for clicks.
  • dailyBudgetLimit – daily limit for budget.
  • totalImpressions – current impressions.
  • totalClicks – current clicks.
  • totalBudget – current budget.
  • dailyImpressions – impressions for current day.
  • dailyClicks – clicks for current day.
  • dailyBudget – budget for current day.
  • removeStartDateLimit - remove start date limit, true/false.
  • removeEndDateLimit - remove end limit, true/false

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.
  • advertiserId – the given Advertiser ID.

Reset Limits

Resets the Advertiser Limits counter values by Advertiser ID and counter type.

URL: /rest-api/advertiser/{advertiserId}/limits/reset.do
Method: DELETE
Response format: application/json

Error codes:

  • 400 Bad Request - wrong request format. No Advertiser with the given Advertiser ID.
  • 401 Unauthorized - authentication error.
  • 403 Forbidden - not enough permissions.
  • 404 Not Found - Limits not enabled or Advertiser not found.

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.
  • advertiserId - the given Advertiser ID.
  • limitCounters - list of counters to reset, available values: TOTAL_IMPRESSIONS, TOTAL_CLICKS, TOTAL_REVENUE, DAILY_IMPRESSIONS, DAILY_CLICKS, DAILY_REVENUE.

Disable Limits

Disables Advertiser Limits for the given Advertiser ID.

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

Error codes:

  • 400 Bad Request – wrong request format. No Advertiser with the given Advertiser ID.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Limits not enabled or Advertiser not found.

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.
  • advertiserId – the given Advertiser ID.

Get Advertiser Per-action Limits

Returns Per-action Limits for the given Advertiser ID.

URL: /rest-api/per-action/limits/ADVERTISER/{advertiserId}.do
Method: GET
Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. Some of provided parameters are invalid.
  • 401 Unauthorized – authentication error.

Response sample:
200 OK
{actionLimits:[
{id:"1", entityId:"1", totalConversionsLimit:"2", totalConversions:"1", dailyConversionsLimit:"1", dailyConversionsLimit:"1"}
,...]}

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.

Add Per-action Limit

Adds Per-action Limit for the given Advertiser and Action.

URL: /rest-api/per-action/add/limit/ADVERTISER/{advertiserId}.do
Method: POST
Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. Some of provided parameters are invalid.
  • 401 Unauthorized – authentication error.

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

Parameters:

  • actionId – ID of an Action that should be limited.
  • totalConversionsLimit – a value of Total Per-action Limit.
  • dailyConversionsLimit – a value of Daily Per-action Limit.
  • 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.

Update Per-action Limit

Updates Per-action Limit for the given Advertiser and Action.

URL: /rest-api/per-action/update/limit/ADVERTISER/{advertiserId}.do
Method: POST
Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. Some of provided parameters are invalid.
  • 401 Unauthorized – authentication error.

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

Parameters:

  • actionId – ID of an Action that should be limited.
  • totalConversionsLimit – a value of Total Per-action Limit.
  • dailyConversionsLimit – a value of Daily Per-action Limit.
  • 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.

Delete Per-action Limit

Deletes Per-action Limit for the given Advertiser and Action.

URL: /rest-api/per-action/delete.do
Method: POST
Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. Some of provided parameters are invalid.
  • 401 Unauthorized – authentication error.

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

Parameters:

  • entityId – id of an Advertiser.
  • ids – comma separated per-action limits ids that should be deleted.
  • type – entity type. Should equal to ADVERTISER.
  • 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.

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.