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

Keyword Reporting Methods

Keyword Geo Reporting Methods

getKeywordConvReport

Get a conversion report for the given keyword target and date range.

Parameters

token String API authentication token
keyword_id int The keyword target for which report data is being requested
start_date Date Desired start date for report
end_date Date Desired end date for report

Response

KeywordConvReportStruct A data structure containing keyword conversion report information for the specified date range

getKeywordConvReportsForAccount

Get conversion reports for all keyword targets in the specified account for the given date range.

Parameters

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

Response

KeywordConvReportStruct[] An array of data structures containing keyword conversion report information for all keywords in the specified account for the given date range

getAllKeywordConvReportsForAccountByPage

Get paginated conversion report information for all keyword targets in the specified account for the given date range.

Parameters

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

Response

KeywordConvReportStruct[] An array of data structures containing keyword conversion report information for all keywords in the specified account for the given page and date range

getKeywordConvReportsForCampaign

Get a conversion report for all keyword targets in the specified campaign for the given date range.

Parameters

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

Response

KeywordConvReportStruct[] An array of data structures containing keyword conversion report information for all keywords in the specified campaign for the given date range

getKeywordConvReportsForCampaignByPage

Get a paginated conversion report for all keyword targets in the specified campaign for the given date range.

Parameters

token String API authentication token
campaign_id int The campaign for which keyword report data is being requested
start_date Date Desired start date for report
end_date Date Desired end date for report
page int The desired page

Response

KeywordConvReportStruct[] An array of data structures containing keyword conversion report information for all keywords in the specified campaign for the given page and date range

getKeywordGeoReport

Get a click and cost report for the specified keyword target for the given geo location and date range.

Parameters

token String API authentication token
keyword_id int The keyword target for which report data is being requested
start_date Date Desired start date for the report
end_date Date Desired end date for the report
location String Desired location level. Valid location values are as follows:
  • country
  • state
  • dma
  • city
  • postal

Response

KeywordGeoReportStruct A data structure containing keyword traffic report information for the specified date range and geographic location.

getKeywordGeoReportsForAccount

Get a click and cost report for all keyword targets in the specified account for the given geo location and date range.

Parameters

token String API authentication token
account_id int The account for which keyword report data is being requested
start_date Date Desired start date for the report.
end_date Date Desired end date for the report
location String Desired location level. Valid location values are as follows:
  • country
  • state
  • dma
  • city
  • postal

Response

KeywordGeoReportStruct[] An array of data structures containing keyword traffic report information for the specified account, geographic location type and date range.

getKeywordGeoReportsForAccountByPage

Get a paginated click and cost report for all keyword targets in the specified account for the given geo location and date range.

Parameters

token String API authentication token
account_id int The account for which keyword report data is being requested
start_date Date Desired start date for the report
end_date Date Desired end date for the report
location String Desired location level. Valid location values are as follows:
  • country
  • state
  • dma
  • city
  • postal
page int The page number

Response

KeywordGeoReportStruct[] An array of data structures containing keyword traffic report information for the specified account, page, geographic location type and date range.

getKeywordGeoReportsForCampaign

Get a click and cost report for all keyword targets in the specified campaign for the given geo location and date range.

Parameters

token String API authentication token
campaign_id int The account for which keyword report data is being requested
start_date Date Desired start date for the report.
end_date Date Desired end date for the report
location String Desired location level. Valid location values are as follows:
  • country
  • state
  • dma
  • city
  • postal

Response

KeywordGeoReportStruct[] An array of data structures containing keyword traffic report information for the specified campaign, geographic location type and date range.

getKeywordGeoReportsForCampaignByPage

Get a paginated click and cost report for all keyword targets in the specified campaign for the given geo location and date range.

Parameters

token String API authentication token
campaign_id int The campaign for which keyword report data is being requested
start_date Date Desired start date for the report
end_date Date Desired end date for the report
location String Desired location level. Valid location values are as follows:
  • country
  • state
  • dma
  • city
  • postal
page int The page number

Response

KeywordGeoReportStruct[] An array of data structures containing keyword traffic report information for the specified campaign, page, geographic location type and date range.

getKeywordImpReport

Get an impression report for the specified keyword target for the given date range.

Parameters

token String API authentication token
keyword_id int The keyword target for which report data is being requested
start_date Date Desired start date for report
end_date Date Desired end date for report

Response

KeywordImpReportStruct A data structure containing keyword impression report information for the specified date range

getKeywordImpReportsForAccount

Get impression reports for all keyword targets in the specified account for the given date range.

Parameters

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

Response

KeywordImpReportStruct[] An array of data structures containing keyword impression report information for all keywords in the specified account for the given date range

getKeywordImpReportsForAccountByPage

Get paginated impression reports for all keyword targets in the specified account for the given date range.

Parameters

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

Response

KeywordImpReportStruct[] An array of data structures containing keyword impression report information for all keywords in the specified account for the given page and date range

getKeywordImpReportsForCampaign

Get impression reports for all keyword targets in the specified campaign for the given date range.

Parameters

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

Response

KeywordImpReportStruct[] An array of data structures containing keyword impression report information for all keywords in the campaign specified for the given date range

getKeywordImpReportsForCampaignByPage

Get paginated impression reports for all keyword targets in the specified campaign for the given date range.

Parameters

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

Response

KeywordImpReportStruct[] An array of data structures containing keyword impression report information for all keywords in the specified campaign for the given page and date range

getKeywordReport

Get a traffic report for the specified keyword target for the given date range.

Parameters

token String API authentication token
keyword_id int The keyword target for which report data is being requested
start_date Date Desired start date for report
end_date Date Desired end date for report

Response

KeywordReportStruct A data structure containing keyword traffic report information for the specified date range

getKeywordReportsForAccount

Get a click and cost report for all keyword targets in the specified account for the given date range.

Parameters

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

Response

KeywordReportStruct[] An array of data structures containing keyword traffic report information for all keywords in the specified account for the given and date range

getKeywordReportsForAccountByPage

Get a paginated click and cost report for all keyword targets in the specified account for the given date range.

Parameters

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

Response

KeywordReportStruct[] An array of data structures containing keyword traffic report information for all keywords in the specified account for the given page and date range

getKeywordReportsForCampaign

Get a click and cost report for all keyword targets in the specified campaign for the given date range.

Parameters

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

Response

KeywordReportStruct[] An array of data structures containing keyword traffic report information for all keywords in the specified campaign for the given date range

getKeywordReportsForCampaignByPage

Get a paginated click and cost report for all keyword targets in the specified campaign for the given date range.

Parameters

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

Response

KeywordReportStruct[] An array of data structures containing keyword traffic report information for all keywords in the specified campaign for the given page and date range

getNumKeywordConvReportPagesForAccount

Get the total number keyword conversion report pages for the specified 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 keyword conversion report pages for the specified account

getNumKeywordConvReportPagesForCampaign

Get the total number of keyword conversion report pages for the specified 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 keyword conversion report pages for the specified campaign

getNumKeywordGeoReportPagesForAccount

Get the total number of keyword traffic report pages for the specified account, geo location and date range.

Parameters

token String API authentication token
campaign_id int The target account
start_date Date Desired start date for the report
end_date Date Desired end date for the report
location String Desired location level. Valid location values are as follows:
  • country
  • state
  • dma
  • city
  • postal

Response

int The total number of keyword traffic report pages for the specified account and geographic location

getNumKeywordGeoReportPagesForCampaign

Get the total number of keyword traffic report pages for the specified campaign, geo location and date range.

Parameters

token String API authentication token
campaign_id int The target campaign
start_date Date Desired start date for the report
end_date Date Desired end date for the report
location String Desired location level. Valid location values are as follows:
  • country
  • state
  • dma
  • city
  • postal

Response

int The total number of keyword traffic report pages for the specified campaign and geographic location

getNumKeywordImpReportPagesForAccount

Get the total number keyword impression report pages for the specified 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 keyword impression report pages for the specified account

getNumKeywordImpReportPagesForCampaign

Get the total number of keyword impression report pages for the specified 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 keyword impression report pages for the specified campaign

getNumKeywordReportPagesForAccount

Get the total number keyword traffic report pages for the specified 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 keyword traffic report pages for the specified account

getNumKeywordReportPagesForCampaign

Get the total number of keyword traffic report pages for the specified 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 keyword traffic report pages for the specified campaign