Reports

Headline numbers for a project and window

Returns the headline numbers of one project for a window and filters, in three blocks that match three app pages. overview (the Overview page) counts saved monitoring checks: checks_saved = search result pages saved; ads_observed = paid ad occurrences in them (one advertiser seen in ten checks counts ten times); advertiser_domains = distinct advertiser domains; active_keywords = keywords with paid monitoring on. paid_results (the Paid results page) also includes imported studies unless engine or country filters are set: observations = saved checks (the visibility denominator); each own domain's visibility = observations where it showed at least one ad / observations, not impression share; segments count advertiser domains tagged affiliate, brand_mention (the ad copy names the brand), coupon or lookalike, which are signals to review. affiliate_cases (the Non-compliant affiliates page) counts your affiliate IDs seen behind ads that used the brand, by review status. data_state says whether nothing was saved yet, nothing matched the selection, or checks found no ads: zero ads is a result only when checks were saved. Use this for triage; to compare periods, request the same filters for a previous comparable window, then inspect notable changes with get_timeseries or get_advertiser before recommending action. Defaults to the last 30 days in the person's time zone.

get/projects/{project_id}/summary

Request

  • Base URL: https://adslighthouse.com/api/v1
  • URL: https://adslighthouse.com/api/v1/projects/{project_id}/summary
  • 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

Headline numbers for a project and window

data_state'no_checks_saved' | 'no_checks_in_selection' | 'no_ads_found' | 'ads_found' required

no_checks_saved: the project has never saved a check. no_checks_in_selection: nothing matches this window and filters (no data, not zero). no_ads_found: checks were saved and none showed a paid ad. ads_found: at least one ad was observed.

notestring nullable required

A caution about sample size or configuration to repeat when reporting results.

request_idstring

Changes

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