Advertisers API

You can take advatange of Audify RESTful API to programatically manage your advertising. This is mostly used if you are bidding in real-time on Audify Network.

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.

Campaigns

Manage campaigns and creatives programatically.

Display Campaign Object and Attributes

Endpoint URL

GET api.audify.io/v1/campaigns
POST api.audify.io/v1/campaigns
GET api.audify.io/v1/campaigns/{CAMPAIGN_TOKEN}
PUT api.audify.io/v1/campaigns/{CAMPAIGN_TOKEN}
POST api.audify.io/v1/campaigns/{CAMPAIGN_TOKEN}/remove

Sample Campaign Object

{
  id: "7C6VUzo5xuvh7oGAuvMJ",
  title: "Campaign Title",
  strategy: "CPM",
  cpc: 1.5,
  currency: "USD",
  device_list: ["desktop","mobile","tablets"],
  platform_list: ["ios","android"],
  category_list: ["arts"],
  country_list: ["US","UK"],
  carrier_list: ["o2","t-mobile"],
  starts_at: Mon, 01 Jan -4712 00:00:00 +0000,
  ends_at: Mon, 19 May 2014 10:00:00 UTC +00:00, 
  paused: false,
  default_url: "http://my.site/landing",
  sites: 
    [
      "http://site1.com",
      "http://site2.com"
    ],
  creatives: 
    [
      {
        id: "vG8yyzsmkISEvOW7PtKm",
        file: {GIF/JPG/PNG FILE},
        code: {CREATIVE CODE},
        paused: false,
        approved: true,
      }
    ],
}

Attributes

strategy	string. Values: cpm, cpc or cpa.
cpm	integer value
cpc	integer value
cpa	integer value
currency	string. Values: USD
category_list	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_list	array Values: desktop, mobile, tablets
platform_list	array Values: android, ios, windows, macintosh, linux
carrier_list	array
starts_at	timestamp
ends_at	timestamp
paused	boolean
default_url	string

Goals

Manage goals programatically.

Display Goal Object and Attributes

Endpoint URL

GET api.audify.io/v1/goals
POST api.audify.io/v1/goals
GET api.audify.io/v1/goals/{GOALS_TOKEN}
PUT api.audify.io/v1/goals/{GOALS_TOKEN}
POST api.audify.io/v1/goals/{GOALS_TOKEN}/remove

Sample Goal Object

{
  id: "7C6VUzo5xuvh7oGAuvMJ",
  title: "Goal Title"
}

Attributes

title

string.

Reports

Retrieve real-time information from your campaigns, creatives using more than one dimension.

Display Report Object and Arguments

Endpoint URL

GET api.audify.io/v1/reports

Sample Report Object

{
  advertiser_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: {object},
  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

All ads received requires to been approved. If they are not they will be send to the queue for approval.