Group Documentation for
API methods to manage one or multiple
groups .
API Version 1.4.5 (build 20231101). This page was updated on Thu, 30 Nov 23 17:07:08 -0500. 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 Return the number of active, deleted and total groups in your account.
Additional Parameters Sample Request Sample Response <Groups total="20" active="20" deleted="0"/> AS.Groups.getList Return the list of groups in your account.
Additional Parameters Parameter Required Description status OptionalDefault value is empty Filter groups with this status. Possible value: 'active','pending','archived' perpage OptionalDefault value is "10" The number of items per page. Maximum value is 100. page OptionalDefault value is "1" The page number
Sample Request Sample Response <Groups total="20" page="1" numpage="5" perpage="4">
<Group id="532" name="top" status="active"/>
<Group id="2600" name="Test Group" status="active"/>
<Group id="9252" name="New Group 1613428659" status="active"/>
<Group id="9253" name="New Group 1613429765" status="active"/>
</Groups> AS.Groups.create Create a new group in your account. Submit via POST. Limit 50 calls/day.
Additional Parameters Parameter Required Description name Required The name of this group
Sample Request Sample Response <Group id="999" name="SampleGroup" status="active"></Group> AS.Group.getInfo Return the list of linked ads for this group
Additional Parameters Parameter Required Description 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/>
</Group> AS.Group.getStats Return the stats for this group. Limit 50 calls/day.
Additional Parameters Parameter Required Description 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", "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> AS.Group.getBreakdownStats Return the breakdown stats of linked ads for this group. Limit 50 calls/day.
Additional Parameters Parameter Required Description group Required The group ID token Required The authentication MD5 hash generated from concatenating [Group ID][Group Name] subcategory Required The type of subcategory can be "ad" metric Required The type of metric can be "impressions", "clicks", "events", "impclkctr", "uniqueimpressions", "uniqueclicks", "uniqueimpclkctr" range Required The time range can be "today", "yesterday", "last7days", "lastmonsun", "lastmonfri", "last31days", "thismo", "lastmo"
Sample Request Sample Response <StatRows generated="Mon, 01 Jan 16 11:11:11 -0400">
<StatRow>
<Name>Ad-ABC</Name>
<Impressions>7,443</Impressions>
<Clicks>0</Clicks>
<CTR>0.0000</CTR>
</StatRow>
<StatRow>
<Name>Ad-DEF</Name>
<Impressions>4,843</Impressions>
<Clicks>0</Clicks>
<CTR>0.0000</CTR>
</StatRow>
<StatRow>More Rows...</StatRow>
</StatRows> AS.Group.getVisitorStats Return the visitor report for this group. Limit 50 calls/day.
Additional Parameters Parameter Required Description 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", "platform", "ua", "screen", "cookie" range Required The time range can be "last7days", "last31days", "thismo", "lastmo", "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> AS.Group.edit Edit a setting of a group. Submit via POST.
Additional Parameters Parameter Required Description group Required The group ID token Required The authentication MD5 hash generated from concatenating [Group ID][Group Name] name OptionalDefault value is empty Sets the new group name
Sample Request Sample Response <Group id="2600" name="Test Group" status="active">
<Description>Test Group For Demo</Description>
<Ads/>
</Group> 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 Website "Documentation for API methods to manage one or multiple websites. API Version1.4.5 (build 20231101). This page was updated on Mon, ..." Campaign "Documentation for API methods to manage your campaigns in our ad server. API Version1.4.5 (build 20231101). This page was updated ..." Publisher "Documentation for API methods to manage a publisher account. API Version1.4.5 (build 20231101). This page was updated on Fri, 24 ..." Channels "Documentation for API methods to manage one or multiple channels. API Version1.4.5 (build 20231101). This page was updated on Fri, ..." Group "A group is a collection of ads. A group is an ad management entity that is different from a zone. ..."