Get all available Actions

URL: /rest-api/actions.do
Method: GET
Response format: application/json
Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Parameters:

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

Get Action Key for the Action

URL: /rest-api/campaign/{campaignId}/actions.do

Method: GET

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Campaign with given ID doesn't exist.

Parameters:

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

Get Action by Action Key

URL: /rest-api/action/{actionKey}.do

Method: GET

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – no action with given actionKey found for given Campaign.

Parameters:

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

Update Action

URL: /rest-api/action/{actionKey}/update.do

Method: POST

Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types for parameters.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used for hash generation.
  • username – a given username.
  • key – action key.
  • name – action name.
  • clickToConversionTimeFrame – period for click to conversion.
  • clickToConversionTimeFramePeriodType – period type, available values: HOUR, DAY, WEEK, MONTH, YEAR.
  • viewToConversionTimeFrame – period for view to conversion.

Create new Action

URL: /rest-api/action/create.do
Method: POST
Response format: application/json
Error codes:

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

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used for hash generation.
  • username – a given username.
  • name – action name.
  • campaignId – ID of the Campaign. The request response will contain the Action Key for the specified Campaign.
  • clickToConversionTimeFrame – period for click to conversion.
  • clickToConversionTimeFramePeriodType – period type, available values: HOUR, DAY, WEEK, MONTH, YEAR.
  • viewToConversionTimeFrame – period for view to conversion.
  • viewToConversionTimeFramePeriodType – period type, available values: HOUR, DAY, WEEK, MONTH, YEAR.

Remove Action by Action Key

URL: /rest-api/action/{actionKey}/delete.do
Method: DELETE
Response format: application/json
Error codes:

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

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 for hash generation.
  • username – a given username.

Enable Campaign Actions

URL: /rest-api/campaign/{campaignId}/enable-actions.do
Method: POST
Response format: application/json
Error codes:

  • 400 Bad Request – wrong request format. E.g., Campaign Pricing is not enabled or Campaign 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 for hash generation.
  • username – a given username.
  • campaignId – the given Campaign ID.

Disable Campaign Actions

URL: /rest-api/campaign/{campaignId}/disable-actions.do
Method: POST
Response format: application/json
Error codes:

  • 400 Bad Request – wrong request format. E.g., Campaign Pricing is not enabled or Campaign 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 for hash generation.
  • username – a given username.
  • campaignId – the given Campaign 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.