This documentation describes the current OddBytes Advertiser API v3.4.1 functionality (last v3 update: 3/1/2021).

Please let us know if you have any questions, if you spot any issues, or if you have suggestions for further improvements.

You can find API services definitions in form of SOAP WSDL resources at https://api.oddbytes.com/?v3=service_name.wsdl where service_name is the name of SOAP service you want to use. Available service names are listed below.

For example, you should use https://api.oddbytes.com/?v3=targets.wsdl as the service endpoint URL in order to perform operations with targets.

There are six API services available (clicking on the services names below leads to their WSDL definitions — please note that the XML content of each WSDL contains embedded documentation for the represented SOAP service):

Authentication credentials are required to be specified within the SOAP XML request header. You need to invoke AuthenticateRequest operation and provide the API key as its only parameter, please see available examples for more details.

If you need to have your API key (re)issued, please go to the API Settings page in your OddBytes account, where you can also enter or update developer contact data for your account.

Please note that your API key is paired with a list of lockdown IP addresses, meaning that access to your account through the Advertiser API is allowed only from those IP addresses for additional security of your data. Current list of your lockdown IP addresses is available in the upper right corner of this documentation.

Please use the list of available API services on the left-hand side, listed together with their respective available operations.

By clicking on any of the listed services or operations, you can find detailed documentation and descriptions of their intended usage, available operations for each service, values, and types for operations parameters and return values.

Please note that the effects of pausing, resuming and other operations (in terms of your previously active and then paused creatives stopping to receive traffic, for example) are becoming effective generally 10 minutes after the respective API operations are accepted and returned as successfully processed by the API server.

API Sandbox environment can be accessed and used simply by replacing api.oddbytes.com with apitest.trafficvance.com within the SOAP services endpoints as listed earlier on this page.

For example, you should use https://apitest.trafficvance.com/?v3=targets.wsdl as the service endpoint URL in order to perform Sandbox operations with targets.

API key for the Sandbox environment is 8e002cadaf9d7225a19f0f710650757d35756080, having no limitations regarding the IP addresses from which it can be accessed.

Important note: API Sandbox environment contains dummy test data, having nothing in common or shared with the data in your live OddBytes account. The whole Sandbox environment and all data contained within it are shared between all API customers, meaning the Sandbox is supposed to be used for testing purposes only, and no private data should be stored or used during testing.