Reports

Presence by local hour and weekday

Returns 168 cells, one per local weekday (1 = Monday … 7 = Sunday) and hour (0–23) in the window's time zone, each with checks, checks with the advertiser and presence_rate. A cell with no checks is unmeasured (null), not zero presence. Compare the measured cells with the project's schedule before inferring when an advertiser tends to appear. presence_rate = checks_with_advertiser / checks over saved monitoring checks, the same calculation as visibility in list_advertisers. It describes this sample, not impression share, spend, or proof that a keyword was bought. Hours or days without checks are not evidence of absence.

get/projects/{project_id}/advertisers/{domain}/heatmap

Request

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

domainstring required

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

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[]
keywordstring

Only checks of this exact keyword text, as list_keywords returns it.

Response

Presence by local hour and weekday

domainstring required
time_zonestring required
request_idstring

Changes

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