Publishers API

You can take advatange of Audify RESTful API to programatically display the advertising.

API Endpoint

http://api.audify.io

Output is returned on JSON by default. XML is also available. You can include .json or .xml at the endpoint of the URL.

Authentication

All requestes to Audify using the API need to be authenticated using the api_key provided to you.

You can find your current API key visiting your Account page.

Authentication can be done via HTTP Basic authentication using the key as the username or using the api_key in the URL request.

Sites

Manage sites programatically.

Display Site Object and Attributes

Endpoint URL

GET api.audify.io/v1/sites
POST api.audify.io/v1/sites
GET api.audify.io/v1/sites/{SITE_TOKEN}
PUT api.audify.io/v1/sites/{SITE_TOKEN}
POST api.audify.io/v1/sites/{SITE_TOKEN}/remove

Sample Site Object

{
  id: "7C6VUzo5xuvh7oGAuvMJ",
  domain: "mysite.com",
  category: "arts",
  placements: 
    [
      {
        id: "vG8yyzsmkISEvOW7PtKm",
        width: 300,
        height: 250,
        minimum_epm: 1.5,
        fallback_code: ...,
      }
    ],
}

Placements

Manage your site placements.

Display Placement Object and Attributes

Endpoint URL

GET api.audify.io/v1/placements
POST api.audify.io/v1/placements
GET api.audify.io/v1/placements/{PLACEMENT_TOKEN}
PUT api.audify.io/v1/placements/{PLACEMENT_TOKEN}
POST api.audify.io/v1/placements/{PLACEMENT_TOKEN}/remove

Sample Placement Object

{
  id: "vG8yyzsmkISEvOW7PtKm",
  site_id: "7C6VUzo5xuvh7oGAuvMJ"
  width: 300,
  height: 250,
  minimum_epm: 1.5,
  fallback_code: ...,
}

Reports

Retrieve real-time information from what you displayed using more than one dimension.

Display Report Object and Arguments

Endpoint URL

GET api.audify.io/v1/reports

Sample Report Object

{
  publisher_id: "7C6VUzo5xuvh7oGAuvMJ",
  country: "US",
  campaign "7C6VUzo5xuvh7oGAuvMJ",
  platform: "mobile",
  device: "android",
  category: "arts",
  carrier: "att",
  date: "Mon, 19 May 2014",
  views: 23432,
  clicks: 234,
  spent: 54.23,
  currency: "USD",
  goals: 4
}

Arguments

You can use the following arguments to query information from the reports. You can use comas in your query to retrieve more than one attribute from a dimension.

country	country code. Values: US, UK, ...
category	array Values: arts, automotive, books, business, careers, celebrities, dating, education, family, fashion, finance, food, games, health, home, humor, illegal content, interests, movies, music, news, non-standard content, pets, politics, real estate, religion, science, shopping, sports, television, adult
device	array Values: desktop, mobile, tablets
platform	array Values: android, ios, windows, macintosh, linux
carrier	array

Transactions

History of all transactions made including views, clicks, goals, deposits and withdrawals.

Display Transaction Object and Arguments

Endpoint URL

GET api.audify.io/v1/transactions

Sample Transaction Object

{
  id: "7C6VUzo5xuvh7oGAuvMJ",
  amount: 12.3,
  assignable: true,
  transactionable: {objetct},
  track:
  report:
}

Arguments

You can use the following arguments to query information from transactions.

offset	Optional. Default is 0
limit	Optional. Default is 50 Maximum 1000