Reports

Chart-ready paid-search and Shopping aggregates for one project

Returns chart-ready aggregates for one authorized project and date window, using the same observation filters as the app. Use these metrics to find changes in monitored search results, then inspect the matching observations before drawing a conclusion. Paid-search charts include saved checks and eligible imported studies; studies are excluded when engine or ISO-country filters are selected because they do not record those dimensions. Shopping aggregates are null when the account's plan does not include Shopping. Counts are grouped before any chart display limit; unavailable dimensions are omitted rather than represented as zero. Connected Google Ads and Search Console reports are separate live data and are not historical chart inputs. The window defaults to the last 30 days in the person's time zone.

get/projects/{project_id}/analytics

Request

  • Base URL: https://adslighthouse.com/api/v1
  • URL: https://adslighthouse.com/api/v1/projects/{project_id}/analytics
  • Auth: HTTP bearer

Path parameters

project_idstring required

The project: its id, its brand domain (for example nike.example) or its exact project or brand name. Unknown or ambiguous references return not_found; call list_projects then.

Query parameters

range'7d' | '14d' | '30d' | '12m' | 'custom'

Window ending today: 7d, 14d, 30d (default) or 12m. Use custom with from and to for fixed dates.

fromstring

First local day, YYYY-MM-DD (custom range).

tostring

Last local day, YYYY-MM-DD, included in full (custom range).

time_zonestring

IANA time zone for day boundaries, such as America/New_York. Defaults to the time zone of the person the credential acts for.

'google' | 'bing'
OR
string[]
'desktop' | 'mobile'
OR
string[]
'windows' | 'macos' | 'android' | 'ios' | 'unspecified'
OR
string[]
string
OR
string[]
string
OR
string[]

Response

Chart-ready paid-search and Shopping aggregates for one project

data_state'no_observations' | 'no_ads' | 'ads_found' required
observationsinteger required
ads_observedinteger required
advertiser_domainsinteger required
active_keywordsinteger required

Keywords currently monitored for paid search in this project; this count is independent of the selected date window and observation filters.

request_idstring

Changes

No recorded changes to this operation across all 1 revision of this API.