Help Center Manage Your Account AdSpeed API

Website

Documentation for API methods to manage one or multiple websites.

API Version

1.4.5 (build 20231101). This page was updated on Sat, 09 Mar 24 14:46:48 -0500. 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
<Websites total="1" active="1" deleted="0"/>

AS.Websites.getList

Return the list of websites for this publisher or ad network
Additional Parameters
ParameterRequiredDescription
perpageOptional
Default value is "10"
The number of items per page. Maximum value is 100.
pageOptional
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

Return the list of linked zones, ads and users for this website
Additional Parameters
ParameterRequiredDescription
siteRequiredThe website ID
tokenRequiredThe 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" secondary="7607">
      <Ads>
        <Ad id="35093" name="Sample Text Ad" status="active"/>
        <Ad id="36943" name="Sample Image Ad" status="active" width="468" height="60"/>
        <Ad id="40631" name="Sample Rich HTML Ad" status="pending" width="300" height="250"/>
        <Ad id="54412" name="Sample Text Link Ad" status="pending"/>
      </Ads>
    </Zone>
  </Zones>
</Website>

AS.Website.getStats

Return the stats for this website. Limit 50 calls/day.
Additional Parameters
ParameterRequiredDescription
siteRequiredThe website ID
tokenRequiredThe authentication MD5 hash generated from concatenating [Site ID][Site Name]
metricRequiredThe type of metric can be "impressions", "clicks", "revenue", "expense", "events"
periodRequiredThe 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>
Print Was this helpful? Yes / No

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