Help Center Manage Your Account AdSpeed API

Group

Documentation for API methods to manage one or multiple groups.

API Version

1.2.5 (build 20150921). This page was updated on Sun, 25 Sep 16 22:51:03 -0400. Since the API method and response format can change from one version to another, you should check this page for updates.

API Methods - Group

AS.Groups.getCounts

Returns the number of active, deleted and total groups for this publisher or ad network
Parameters
  • None
Sample Request
Sample Response
<Groups total="2" active="2" deleted="0"/>

AS.Groups.getList

Returns the list of groups for this publisher or ad network
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
<Groups total="2" page="1" numpage="1" perpage="4">
  <Group id="532" name="top" status="active"/>
  <Group id="2600" name="Test Group" status="active"/>
</Groups>

AS.Group.getInfo

Returns the list of linked ads for this group
Parameters
  • group Required
    The group ID
  • token Required
    The authentication MD5 hash generated from concatenating [Group ID][Group Name]
Sample Request
Sample Response
<Group id="2600" name="Test Group" status="active">
  <Description>Test Group For Demo</Description>
  <Ads>
    <Ad id="36943" name="Sample Image Ad" status="pending" width="468" height="60"/>
  </Ads>
</Group>

AS.Group.getStats

Returns the stats for this group. Limit 50 calls/day.
Parameters
  • group Required
    The group ID
  • token Required
    The authentication MD5 hash generated from concatenating [Group ID][Group Name]
  • metric Required
    The type of metric can be "impressions", "clicks", "revenue", or "expense"
  • period Required
    The breakdown period can be "hourly", "daily", "weekly", or "monthly"
Sample Request
Sample Response
<StatRows generated="[Time Stamp]" title="[Entity Name]">
  <StatRow>
    <Monthly>January 2014</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>

AS.Group.getVisitorStats

Returns the visitor report for this group. Limit 50 calls/day.
Parameters
  • group Required
    The group ID
  • token Required
    The authentication MD5 hash generated from concatenating [Group ID][Group Name]
  • metric Required
    The type of metric can be 'countries', 'continents', 'areas', 'timezones', 'regions', 'languages', 'browsermajor', 'browserminor', 'os', 'ua', 'screen', 'java', 'cookie'
  • range Required
    The range can be "alltime"
Sample Request
Sample Response
<StatRows generated="[Time Stamp]" title="[Entity Name]" range="Alltime" metric="countries">
  <StatRow>
    <Rank>1</Rank>
    <Country>United States</Country>
    <Flag/>
    <Percentage>95%</Percentage>
  </StatRow>
  <StatRow>
    <Rank>2</Rank>
    <Country>Canada</Country>
    <Flag/>
    <Percentage>5%</Percentage>
  </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