Reports

Checks, ads and advertisers by local day, week or month

Returns one row per local day, week (starting Monday) or month with saved monitoring checks, in the person's time zone or time_zone: checks_saved, ads_observed (ad occurrences) and advertiser_domains (distinct domains in that period). A period without saved checks is absent: nothing was measured, which is not the same as zero ads. Pass advertiser to add that domain's visibility per period = checks where it showed at least one ad / checks_saved; it is not impression share. Compare like-for-like windows and filters, and check changes in checks_saved before attributing a change in observed presence to the market. Imported studies are not included, as on the Overview chart. The default granularity matches the Overview chart: days, or months for windows longer than 62 days.

get/projects/{project_id}/timeseries

Request

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

granularity'day' | 'week' | 'month'

Period length. Defaults to day, or month for windows longer than 62 days.

advertiserstring

Advertiser domain as it appears in list_advertisers, such as rival.example.

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

Checks, ads and advertisers by local day, week or month

granularity'day' | 'week' | 'month' required
advertiserstring nullable required
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.