LookSmart® API v4.0 Developer Implementation Guide
  Introduction
  Accounts Service
  Campaigns Service
  Ad Groups Service
  Ads Service
  Keywords Service
  Reports Service
  Geo Locations
Frequently Asked Questions
Implementation Guide

version 3
 

Reports Service

Please note that neither impression nor conversion data is available before 03/22/2008. API requests for campaign, ad or keyword impression or conversion data before that date will result in an error.

WSDL

Ad Group Reporting Methods

getAdGroupConvReport

Get a conversion report for the specified ad group for the given date range.

Parameters

token String API authentication token
ad_group_id int The target ad group
start_date Date Desired start date for the report
end_date Date Desired end date for the report

Response

AdGroupConvReportStruct A data structure containing ad group conversion report information for the specified date range

getAdGroupConvReportsForAccount

Get conversion reports for all ad groups in the specified account for the given date range.

Parameters

token String API authentication token
account_id int The account for which ad group report data is being requested
start_date Date Desired start date for the report
end_date Date Desired end date for the report

Response

AdGroupConvReportStruct[] An array of data structures containing ad group conversion report information for all ad groups in the specified account for the given date range

getAdGroupConvReportsForAccountByPage

Get paginated conversion report information for all ad groups within the specified account.

Parameters

token String API authentication token
account_id int The account for which ad group report data is being requested
start_date Date Desired start date for the report.
end_date Date Desired end date for the report
page int The page number

Response

AdGroupConvReportStruct[] An array of data structures containing ad group conversion report information for all ad groups in the specified account for the given page and date range

getAdGroupConvReportsForCampaign

Get conversion reports for all ad groups in the specified campaign for the given date range.

Parameters

token String API authentication token
campaign_id int The campaign for which ad group report data is being requested
start_date Date Desired start date for the report
end_date Date Desired end date for the report

Response

AdGroupConvReportStruct[] An array of data structures containing ad group conversion report information for all ad groups in the specified campaign for the given date range

getAdGroupConvReportsForCampaignByPage

Get paginated conversion report information for all ad groups within the specified campaign.

Parameters

token String API authentication token
campaign_id int The campaign for which ad group report data is being requested
start_date Date Desired start date for the report.
end_date Date Desired end date for the report
page int The page number

Response

AdGroupConvReportStruct[] An array of data structures containing ad group conversion report information for all ad groups in the specified campaign for the given page and date range

getAdGroupImpReport

Get impression reporting information for the specified ad group and date range.

Parameters

token String API authentication token
ad_group_id int The target ad group
start_date Date Desired start date for the report
end_date Date Desired start date for the report

Response

AdGroupImpReportStruct A data structure containing ad group impression report information for the specified date range

getAdGroupImpReportsForAccount

Get impression reports for all ad groups in the specified account for the given date range.

Parameters

token String API authentication token
account_id int The account for which ad group report data is being requested
start_date Date Desired start date for the report
end_date Date Desired end date for the report

Response

AdGroupImpReportStruct[] An array of data structures containing ad group impression report information for all ad groups in the specified account for the given date range

getAdGroupImpReportsForAccountByPage

Get paginated impression reports for all ad groups within the specified account.

Parameters

token String API authentication token
account_id int The account for which ad group report data is being requested
start_date Date Desired start date for the report.
end_date Date Desired end date for the report
page int The page number

Response

AdGroupImpReportStruct[] An array of data structures containing ad group impression report information for all ad groups in the specified account for the given page and date range

getAdGroupImpReportsForCampaign

Get impression report information for all ad groups in the specified campaign for the given date range.

Parameters

token String API authentication token
campaign_id int The campaign for which ad group report data is being requested
start_date Date Desired start date for the report
end_date Date Desired end date for the report

Response

AdGroupImpReportStruct[] An array of data structures containing ad group impression report information for all ad groups in the specified campaign for the given date range

getAdGroupImpReportsForCampaignByPage

Get paginated impression report information for all ad groups within the specified campaign.

Parameters

token String API authentication token
campaign_id int The campaign for which ad group report data is being requested
start_date Date Desired start date for the report
end_date Date Desired end date for the report
page int The page number

Response

AdGroupImpReportStruct[] An array of data structures containing ad group impression report information for all ad groups in the specified campaign for the given page and date range

getAdGroupReport

Get traffic reporting information for the specified ad group and date range.

Parameters

token String API authentication token
ad_group_id int The target ad group
start_date Date Desired start date for the report
end_date Date Desired start date for the report

Response

AdGroupReportStruct A data structure containing ad group traffic report information for the specified date range

getAdGroupReportsForAccount

Get traffic reports for all ad groups in the specified account for the given date range.

Parameters

token String API authentication token
account_id int The account for which ad group report data is being requested
start_date Date Desired start date for the report
end_date Date Desired end date for the report

Response

AdGroupReportStruct[] An array of data structures containing ad group traffic report information for all ad groups in the specified account for the given date range

getAdGroupReportsForAccountByPage

Get paginated traffic reports for all ad groups within the specified account.

Parameters

token String API authentication token
account_id int The account for which ad group report data is being requested
start_date Date Desired start date for the report.
end_date Date Desired end date for the report
page int The page number

Response

AdGroupReportStruct[] An array of data structures containing ad group traffic report information for all ad groups in the specified account for the given page and date range

getAdGroupReportsForCampaign

Get traffic report information for all ad groups in the specified campaign for the given date range.

Parameters

token String API authentication token
campaign_id int The campaign for which ad group report data is being requested
start_date Date Desired start date for the report
end_date Date Desired end date for the report

Response

AdGroupReportStruct[] An array of data structures containing ad group traffic report information for all ad groups in the specified campaign for the given date range

getAdGroupReportsForCampaignByPage

Get a paginated traffic report information for all ad groups within the specified campaign.

Parameters

token String API authentication token
campaign_id int The campaign for which ad group report data is being requested
start_date Date Desired start date for the report
end_date Date Desired end date for the report
page int The page number

Response

AdGroupReportStruct[] An array of data structures containing ad group traffic report information for all ad groups in the specified campaign for the given page and date range

getNumAdGroupConvPagesForAccount

Get the number of pages of ad group conversion reports for the given account and date range.

Parameters

token String API authentication token
account_id int The target account
start_date Date Desired start date for report
end_date Date Desired end date for report

Response

int The total number of ad group conversion report pages for the specified account

getNumAdGroupConvPagesForCampaign

Get the number of pages of ad group conversion reports for the given campaign and date range.

Parameters

token String API authentication token
campaign_id int The target campaign
start_date Date Desired start date for report
end_date Date Desired end date for report

Response

int The total number of ad group conversion report pages for the specified campaign

getNumAdGroupImpPagesForAccount

Get the number of pages of ad group impression reports for the given account and date range.

Parameters

token String API authentication token
account_id int The target account
start_date Date Desired start date for report
end_date Date Desired end date for report

Response

int The total number of ad group impression report pages for the specified account

getNumAdGroupImpPagesForCampaign

Get the number of pages of ad group impression reports for the given campaign and date range.

Parameters

token String API authentication token
campaign_id int The target campaign
start_date Date Desired start date for report
end_date Date Desired end date for report

Response

int The total number of ad group impression report pages for the specified campaign

getNumAdGroupPagesForAccount

Get the number of pages of ad group traffic reports for the given account and date range.

Parameters

token String API authentication token
account_id int The target account
start_date Date Desired start date for report
end_date Date Desired end date for report

Response

int The total number of ad group traffic report pages for the specified account

getNumAdGroupPagesForCampaign

Get the number of pages of ad group traffic reports for the given campaign and date range.

Parameters

token String API authentication token
campaign_id int The target campaign
start_date Date Desired start date for report
end_date Date Desired end date for report

Response

int The total number of ad group traffic report pages for the specified campaign