Set Limits

Set the Limits for the Banner by its ID.

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

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types for parameters or Banner with such ID doesn't exist.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Request Parameters:

  • Long totalImpressionsLimit; Long totalClicksLimit; Double totalBudgetLimit; Long dailyImpressionsLimit; Long dailyClicksLimit; Double dailyBudgetLimit; Long totalImpressions; Long totalClicks; Double totalBudget; Long dailyImpressions; Long dailyClicks; Double dailyBudget.
  • 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 value for Impressions.
  • totalClicks – current value for Clicks.
  • totalBudget – current value for budget.
  • dailyImpressions – value for Impressions for current day.
  • dailyClicks – value for Clicks for current day.
  • dailyBudget – value for 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.
  • bannerId – the given Banner ID.

Update Limits

Updates the Limits information by Banner ID.

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

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types for parameters or Banner with such ID doesn't exist.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Limits not enabled or Banner not found.

Request Parameters:

  • Long totalImpressionsLimit; Long totalClicksLimit; Double totalBudgetLimit; Long dailyImpressionsLimit; Long dailyClicksLimit; Double dailyBudgetLimit; Long totalImpressions; Long totalClicks; Double totalBudget; Long dailyImpressions; Long dailyClicks; Double dailyBudget.
  • 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 value for Impressions.
  • totalClicks – current value for Clicks.
  • totalBudget – current value for budget.
  • dailyImpressions – value for Impressions for current day.
  • dailyClicks – value for Clicks for current day.
  • dailyBudget – value for 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.
  • bannerId – the given Banner ID.

Reset Limits

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

URL: /rest-api/banner/{bannerId}/limits/reset.do
Method: POST
Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types for parameters or Banner with such ID doesn't exist.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Limits not enabled or Banner 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.
  • bannerId – the given Banner ID.
  • limitCounters – list of counters to reset, available values: TOTAL_IMPRESSIONS, TOTAL_CLICKS, TOTAL_REVENUE, DAILY_IMPRESSIONS, DAILY_CLICKS, DAILY_REVENUE.

Disable Limits

Disables Banner Limits.

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

Error codes:

  • 400 Bad Request – Banner with such id doesn't exist.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

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.
  • bannerId – the given Banner ID.

Get Limits

Get the Limits' information by Banner ID.

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

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – no Limits set for such Banner.

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.
  • bannerId – the given Banner 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.