Help Center Manage Your Account AdSpeed API
Publisher
Documentation for API methods to manage a publisher account.API Version
1.4.6 (build 20240530). This page was updated on Tue, 12 Nov 24 15:16:11 -0500. Since the API method and response format can change from one version to another, you should check this page for updates.API Methods - Publisher
AS.Publisher.getStats
Return stats for the publisher. Limit 50 calls/day.Additional Parameters
| Parameter | Required | Description |
|---|---|---|
| metric | Required | The type of metric can be "impressions", "clicks", "revenue", "expense", "events" |
| period | Required | The time period can be "hourly", "daily", "weekly", "monthly" |
| range | Optional Default value is empty | The time range can be specified as Start|End using syntax YYYY.MM.DD|YYYY.MM.DD |
Sample Request
Sample Response
<StatRows generated="[Time Stamp]" title="[Entity Name]">
<StatRow>
<Monthly>January 2024</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.Publisher.getBreakdownStats
Return the breakdown stats of linked entities for this publisher or ad network. Limit 50 calls/day.Additional Parameters
| Parameter | Required | Description |
|---|---|---|
| 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 24 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.Publisher.getVisitorStats
Return visitor report for the publisher or ad network. Limit 50 calls/day.Additional Parameters
| Parameter | Required | Description |
|---|---|---|
| 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>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.6 (build 20240530). This page was updated on Fri, ..."
- Group
"Documentation for API methods to manage one or multiple groups. API Version1.4.6 (build 20240530). This page was updated on Mon, ..."
- Campaign
"Documentation for API methods to manage your campaigns in our ad server. API Version1.4.6 (build 20240530). This page was updated ..."
- Zone
"Documentation for API methods to manage one or multiple zones. API Version1.4.6 (build 20240530). This page was updated on Sun, ..."
- How do I generate breakdown reports?
"When viewing a report for an entity, you have an option to drill down into more details. You can view ..."