Help Center Manage Your Account AdSpeed API

Website

Documentation for API methods to manage one or multiple websites.

API Version

1.3.6 (build 20191206). This page was updated on Thu, 12 Mar 20 04:56:47 -0400. Since the API method and response format can change from one version to another, you should check this page for updates.

API Methods - Website

AS.Websites.getCounts

Return the number of active, deleted and total websites for this publisher or ad network
Additional Parameters
  • None
Sample Request
Sample Response
<Error code="999666999">
  <Message>Sorry! An error has been detected</Message>
</Error>

AS.Websites.getList

Return the list of websites for this publisher or ad network
Additional Parameters
  • perpage Optional, default value is "10"
    The number of items per page. Maximum value is 100.
  • page Optional, default value is "1"
    The page number
Sample Request
Sample Response
<html>
  <head>
    <title>Error</title>
  </head>
  <body style="font-family:Arial,sans-serif;font-size:1.1em;margin:0px;background:#E4CBCA;">
    <fieldset style="width:600px;margin:70px auto;padding:20px;"><legend style="font-size:1.6em;">Message</legend>Sorry! An error has been detected. If you need assistance with this error, please <a href="/Helps/contact.html">contact us</a><div style="padding-top:5px;font-size:0.7em;">Message #999666999</div></fieldset>
  </body>
</html>

AS.Website.getInfo

Return the list of linked zones, ads and users for this website
Additional Parameters
  • site Required
    The website ID
  • token Required
    The authentication MD5 hash generated from concatenating [Site ID][Site Name]
Sample Request
Sample Response
<html>
  <head>
    <title>Error</title>
  </head>
  <body style="font-family:Arial,sans-serif;font-size:1.1em;margin:0px;background:#E4CBCA;">
    <fieldset style="width:600px;margin:70px auto;padding:20px;"><legend style="font-size:1.6em;">Message</legend>Sorry! An error has been detected. If you need assistance with this error, please <a href="/Helps/contact.html">contact us</a><div style="padding-top:5px;font-size:0.7em;">Message #999666999</div></fieldset>
  </body>
</html>

AS.Website.getStats

Return the stats for this website. Limit 50 calls/day.
Additional 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", "revenue", "expense", "events"
  • period Required
    The time period can be "hourly", "daily", "weekly", "monthly"
Sample Request
Sample Response
<StatRows generated="[Time Stamp]" title="[Entity Name]">
  <StatRow>
    <Monthly>January 2019</Monthly>
    <Unique_Impression>3,156</Unique_Impression>
    <Gross_Impression>6,565</Gross_Impression>
    <Unique_over_Gross_Impression>48.07%</Unique_over_Gross_Impression>
  </StatRow>
  <StatRow>More Rows...</StatRow>
  <StatRow>
    <Monthly>Total</Monthly>
    <Unique_Impression>57,417</Unique_Impression>
    <Gross_Impression>114,979</Gross_Impression>
    <Unique_over_Gross_Impression>49.94%</Unique_over_Gross_Impression>
  </StatRow>
  <StatRow>
    <Monthly>Average</Monthly>
    <Unique_Impression>4,785</Unique_Impression>
    <Gross_Impression>9,582</Gross_Impression>
    <Unique_over_Gross_Impression>49.94%</Unique_over_Gross_Impression>
  </StatRow>
</StatRows>

Other Articles in AdSpeed API

Documentation to use AdSpeed API to integrate AdSpeed AdServer into your own platform.

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

Related