Help Center Manage Your Account AdSpeed API

Website

Documentation for API methods to manage one or multiple websites.

API Version

1.2.5 (build 280809). Documentation was last modified on Sat, 06 Mar 2010 05:02:27 EST. Since the API methods and response format can change from one version to another, you should check this page frequently for updates.

API Methods - Website

• AS.Websites.getCounts
• AS.Websites.getList
  
  
• AS.Website.getInfo
• AS.Website.getStats

AS.Websites.getCounts

Returns the number of active, deleted and total websites for the publisher

Parameters

• None

Sample Request

Sample Response

<Websites total="1" active="1" deleted="0"/>

AS.Websites.getList

Returns the list of websites for this publisher

Parameters

• perpage (Optional, default value is 10)
  The number of items per page
• page (Optional, default value is 1)
  The page number

Sample Request

Sample Response

<Websites total="1" page="1" numpage="1" perpage="4"> <Website id="89" name="Site Partner A" status="active"/> </Websites>

AS.Website.getInfo

Returns the list of linked zones, ads and users for this website

Parameters

• site (Required)
  The website ID
• token (Required)
  The authentication MD5 hash generated from concatenating [Site ID][Site Name]

Sample Request

Sample Response

<Website id="89" name="Site Partner A" status="active"> <Description>One member of the ad network</Description> <URL>http://siteA.example.com/</URL> <Zones> <Zone id="7549" name="Section Travel" status="active"> <Ads> <Ad id="33628" name="WendyTest" status="active"/> <Ad id="35093" name="Sample Text Ad" status="active"/> <Ad id="36943" name="Sample Image Ad" status="active"/> <Ad id="37704" name="crazyFunAd" status="active"/> <Ad id="38407" name="alertmessenger" status="active"/> <Ad id="40631" name="Sample Rich HTML Ad" status="active"/> <Ad id="43004" name="facebook" status="active"/> <Ad id="47090" name="Politics" status="active"/> <Ad id="54412" name="Sample Text Link Ad" status="active"/> <Ad id="54937" name="Sample Rich HTML Ad 2" status="active"/> <Ad id="56782" name="Sample Image Ad 2" status="active"/> </Ads> </Zone> </Zones> </Website>

AS.Website.getStats

Returns the stats for this website. Limit 50 calls/day

Parameters

• site (Required)
  The website ID
• token (Required)
  The authentication MD5 hash generated from concatenating [Site ID][Site Name]
• metric (Required)
  The type of metric can be "impressions", "clicks" or "revenue"
• period (Required)
  The breakdown period can be "hourly", "daily", or "monthly"

Sample Request

Sample Response

<StatRows generated="Sat, 06 Mar 2010 05:02:28 EST" title="Report: Monthly for [Website] Site Partner A"> <StatRow> <Monthly_Impressions>March 2010</Monthly_Impressions> <Unique>0</Unique> <Gross>0</Gross> <Unique_over_Gross/> </StatRow> <StatRow> <Monthly_Impressions>February 2010</Monthly_Impressions> <Unique>10</Unique> <Gross>24</Gross> <Unique_over_Gross>41.67%</Unique_over_Gross> </StatRow> <StatRow> <Monthly_Impressions>January 2010</Monthly_Impressions> <Unique>1</Unique> <Gross>6</Gross> <Unique_over_Gross>16.67%</Unique_over_Gross> </StatRow> <StatRow> <Monthly_Impressions>December 2009</Monthly_Impressions> <Unique>0</Unique> <Gross>0</Gross> <Unique_over_Gross/> </StatRow> <StatRow> <Monthly_Impressions>November 2009</Monthly_Impressions> <Unique>0</Unique> <Gross>0</Gross> <Unique_over_Gross/> </StatRow> <StatRow> <Monthly_Impressions>October 2009</Monthly_Impressions> <Unique>0</Unique> <Gross>0</Gross> <Unique_over_Gross/> </StatRow> <StatRow> <Monthly_Impressions>September 2009</Monthly_Impressions> <Unique>0</Unique> <Gross>0</Gross> <Unique_over_Gross/> </StatRow> <StatRow> <Monthly_Impressions>August 2009</Monthly_Impressions> <Unique>0</Unique> <Gross>0</Gross> <Unique_over_Gross/> </StatRow> <StatRow> <Monthly_Impressions>July 2009</Monthly_Impressions> <Unique>0</Unique> <Gross>0</Gross> <Unique_over_Gross/> </StatRow> <StatRow> <Monthly_Impressions>June 2009</Monthly_Impressions> <Unique>1</Unique> <Gross>11</Gross> <Unique_over_Gross>9.09%</Unique_over_Gross> </StatRow> <StatRow> <Monthly_Impressions>May 2009</Monthly_Impressions> <Unique>0</Unique> <Gross>0</Gross> <Unique_over_Gross/> </StatRow> <StatRow> <Monthly_Impressions>April 2009</Monthly_Impressions> <Unique>0</Unique> <Gross>0</Gross> <Unique_over_Gross/> </StatRow> <StatRow> <Monthly_Impressions>Total</Monthly_Impressions> <Unique>12</Unique> <Gross>41</Gross> <Unique_over_Gross>29.27%</Unique_over_Gross> </StatRow> <StatRow> <Monthly_Impressions>Average</Monthly_Impressions> <Unique>1</Unique> <Gross>3</Gross> <Unique_over_Gross>29.27%</Unique_over_Gross> </StatRow> </StatRows>

Other Articles in AdSpeed API

• Ad
• AdSpeed API Overview
• Advertiser
• Campaign
• Group
• Publisher
• Sample Code
• Zone

Cannot find an answer for your question? Ask our Customer Care team

Related Articles

• Publisher

  "Documentation for API methods to manage a publisher account. API Version1.2.5 (build 280809). Documentation was last modified on Sun, 07..."

  76% relevant in Manage Your Account AdSpeed API
• Zone

  "Documentation for API methods to manage one or multiple zones. API Version1.2.5 (build 280809). Documentation was last modified on Sat,..."

  72% relevant in Manage Your Account AdSpeed API
• Ad

  "Documentation for API methods to manage one or multiple ads. API Version1.2.5 (build 280809). Documentation was last modified on Sun,..."

  66% relevant in Manage Your Account AdSpeed API
• Campaign

  "Documentation for API methods to manage one or multiple campaigns. API Version1.2.5 (build 280809). Documentation was last modified on Fri,..."

  62% relevant in Manage Your Account AdSpeed API