Help Center Manage Your Account AdSpeed API
Website
Documentation for API methods to manage one or multiple websites.API Version
1.4.6 (build 20240530). This page was updated on Tue, 17 Sep 24 04:20:45 -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 networkAdditional 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 networkAdditional Parameters
Parameter | Required | Description |
---|---|---|
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
<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 websiteAdditional Parameters
Parameter | Required | Description |
---|---|---|
site | Required | The website ID |
token | Required | The 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" weight="10"/> <Ad id="36943" name="Sample Image Ad" status="active" weight="10" width="468" height="60"/> <Ad id="40631" name="Sample Rich HTML Ad" status="pending" weight="10" width="300" height="250"/> <Ad id="54412" name="Sample Text Link Ad" status="pending" weight="10"/> </Ads> </Zone> </Zones> </Website>
AS.Website.getStats
Return the stats for this website. Limit 50 calls/day.Additional Parameters
Parameter | Required | Description |
---|---|---|
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" |
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>
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
- Campaign
"Documentation for API methods to manage your campaigns in our ad server. API Version1.4.6 (build 20240530). This page was updated ..."
- Group
"Documentation for API methods to manage one or multiple groups. API Version1.4.6 (build 20240530). This page was updated on Fri, ..."
- Publisher
"Documentation for API methods to manage a publisher account. API Version1.4.6 (build 20240530). This page was updated on Sun, 13 ..."
- Zone
"Documentation for API methods to manage one or multiple zones. API Version1.4.6 (build 20240530). This page was updated on Wed, ..."
- Website
"A website is a publishing partner of an ad network or a member site of a group of websites. Relationship ..."