---
title: "Presence by local hour and weekday"
method: GET
path: "/projects/{project_id}/advertisers/{domain}/heatmap"
tags: ["Reports"]
---

# Presence by local hour and weekday

`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

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.

## Path parameters

- `project_id` string, 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.
- `domain` string, 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.
- `from` string: First local day, YYYY-MM-DD (custom range).
- `to` string: Last local day, YYYY-MM-DD, included in full (custom range).
- `time_zone` string: IANA time zone for day boundaries, such as America/New_York. Defaults to the time zone of the person the credential acts for.
- `engine` union: Search engine, or a list of engines combined with OR.
  - 'google' | 'bing'
  - string[]
- `device` union: Device, or a list combined with OR.
  - 'desktop' | 'mobile'
  - string[]
- `os` union: Operating system. unspecified matches checks that did not pin one. Must fit the chosen device.
  - 'windows' | 'macos' | 'android' | 'ios' | 'unspecified'
  - string[]
- `country` union: ISO 3166-1 alpha-2 country code such as US, or a list.
  - string
  - string[]
- `location` union: Saved location key: code:<location code>, name:<label> or country:<ISO code>. get_project_details lists the keys that have data.
  - string
  - string[]
- `keyword` string: Only checks of this exact keyword text, as list_keywords returns it.

## Response `200`

Presence by local hour and weekday

- object
  - `domain` string, required
  - `time_zone` string, required
  - `cells` object[], required
    - `checks` integer, required: Saved monitoring checks in the group: the denominator.
    - `checks_with_advertiser` integer, required: Checks where the advertiser showed at least one ad: the numerator.
    - `ads` integer, required: Paid ad occurrences; one check can hold more than one.
    - `presence_rate` number, nullable, required: checks_with_advertiser / checks, 0 to 1; null when the group had no checks.
    - `weekday` integer, required: ISO weekday, 1 = Monday.
    - `hour` integer, required
  - `window` object, required
    - `from` string, required: First local day included, YYYY-MM-DD.
    - `to` string, required: Last local day included, YYYY-MM-DD.
    - `time_zone` string, required
    - `start` string, required: Inclusive start instant, ISO 8601.
    - `end` string, required: Exclusive end instant, ISO 8601.
  - `request_id` string

## Other responses

- `400`: Invalid parameters, cursor or body.
- `401`: Missing, invalid, expired or revoked credential.
- `403`: The credential lacks the write scope, the plan does not include the API, or the allowance is used up.
- `404`: Unknown project, keyword or run in this account.
- `409`: The idempotency key was already used for a different request.
- `429`: Rate limit reached. Retry after the Retry-After seconds.
- `503`: The requested service or file is temporarily unavailable.

---

[API](https://skmtc.dev/adslighthouse/apis/ads-lighthouse-api.md) · [All operations](https://skmtc.dev/adslighthouse/apis/ads-lighthouse-api/llms.txt) · [OpenAPI document](https://skmtc.dev/adslighthouse/apis/ads-lighthouse-api/revisions/e1a4a40b11a9?raw)