ayeT-Studios Advertiser API Documentation (2.4.3)

Download OpenAPI specification:Download

Documentation for ayeT-Studios Advertiser APIs

Latest Changes

2021-03-03: Added new documentation

2019-02-20: v2.4.3 Changes to campaign handling:

  • Valid download rates are now 10-1000000 per day with a default of 1000000 (= unlimited)
  • "limitStrategy" has been removed, all campaigns are running in "burst" mode now

2018-01-17: v2.4.2 Added optional startDate and endDate parameters to reporting/stats to filter statistics to a given date range

2018-01-10: v2.4.1 Added "cost" field to reporting/stats to retrieve campaign costs in summary and on a daily basis

2017-12-29: v2.4 Added support for new incent_cpc campaign type (including example in campaign/add documentation)

2017-12-20: v2.3

  • Documented campaign/edit "addBudget", to programmatically add budget to a running or pending campaign
  • Added "campaign/reactivate" to reactivate completed campaigns, added "cpc" and "nicpi" campaign types to "campaign/add"
  • Deprecated "account/bids" and added new call "account/rates" which lists all campaign types, bid and budget ranges for the advertiser account
  • Unified campaignType for campaign creation and in campaign entities, see Appendix II for a list *. * 2.3 is fully API compatible with 2.2, so "standard" and "retention" types still work for "campaign/add", but are deprecated with 2.3

2017-10-23: v2.2.1 "Error 301 - Invalid country requested" has been removed (non-existing country codes are ignored at campaign creation / update), edit campaign now allows resetting campaign to worldwide targeting by passing "worldwide" or "ZZ" as targetCountries

2017-05-08: v2.2 - Added new campaign types (CPA, Managed CPA, Search / High Retention Search)

2017-03-06: v2.1 - Extended reporting/stats, reporting/summary and reporting/summary_daily with conversion data

2016-06-23: Initial release of APIv2

Introduction

Our Advertiser API enables our clients to automate most of their workflow.

This includes basic account information and full campaign management which allows tight integration of our services in your own website.

We use a REST API with application/json responses. Most of our examples in this documentation are available in different languages.
The PHP examples rely on mod_curl being enabled.

Obtain API Key

To obtain your API Key, use your advertiser account credentials to log into our dashboard.
In the sidebar on the left you'll find the menu entry Account Settings with a menu having the subitem API Settings. This section shows your current API Key and the option to renew it if neccessary.

Get Account Details

Get Account Details

Retrieves information about the associated account, including available funds.

query Parameters
apiKey
required
string

Your Advertiser API Key

Responses

Request samples

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ayetstudios.com/api2/account/details?apiKey=X",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "accountData": {
    }
}

Get Bids

Get Bids Deprecated

Retrieves information for available bid ranges in USD for both android and ios campaigns and different campaign types

query Parameters
apiKey
required
string

Your Advertiser API Key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "android": {
    },
  • "ios": {
    }
}

Get Rates

Get Rates

This call retrieves possible campaign types, bids and budgets (Android and iOS) for your advertiser account

query Parameters
apiKey
required
string

Your Advertiser API Key

Responses

Request samples

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ayetstudios.com/api2/account/rates?apiKey=X",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "android": {