---
title: "One project's configuration and data coverage"
method: GET
path: "/projects/{project_id}"
tags: ["Projects"]
---

# One project's configuration and data coverage

`GET /projects/{project_id}`

## Request

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

Returns one project's brand, owned domains, default market, locations, devices, search engines, schedule and keyword counts, plus which engines, devices, countries and location keys actually have saved observations. Individual keywords may use other country and language pairs; use list_keywords to see each keyword's market. Use the data section to choose filters that can return results.

## 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.

## Response `200`

One project's configuration and data coverage

- object
  - `id` string, required
  - `name` string, required
  - `brand` object, required
    - `name` string, required
    - `domain` string, required
  - `country` string, required: ISO 3166-1 alpha-2 market code.
  - `language` string, required
  - `search_engines` string[], required
  - `devices` string[], required
  - `shopping_enabled` boolean, required
  - `monitoring_frequency` 'manual' | 'daily' | 'twice_daily' | 'four_times_daily' | 'six_times_daily' | 'twelve_times_daily' | 'hourly' | 'every_30_minutes' | 'every_15_minutes', required
  - `runs_per_day` integer, required
  - `randomize_check_times` boolean, required: Each scheduled run starts at a random moment inside its interval.
  - `locations_per_run` integer, nullable, required: Locations each run checks, least recently checked first; null checks every listed location.
  - `status` 'active' | 'paused', required: active runs scheduled checks; paused is set to manual checks only or has no active keyword, as on the Overview projects table.
  - `created_at` string, required
  - `owned_domains` string[], required
  - `locations` object[], required
    - `code` integer, required: Location code used by the location filter as code:<n>.
    - `name` string, required
  - `keyword_count` integer, required
  - `active_keyword_count` integer, required
  - `affiliate_tracking` object, required
    - `configured` boolean, required: True when at least one affiliate URL parameter is set.
    - `parameter` string, nullable, required: The first tracked parameter's name. Kept for older clients; read parameters.
    - `parameters` string[], required: Every tracked rule: a name (fpr, any value is the affiliate ID) or name=value (utm_source=partners, only that exact value).
    - `registered_ids` integer, required
  - `data` object, required: What actually has data, so filters can be chosen without guessing.
    - `observations` integer, required: Saved monitoring checks (search result pages) for this project, all time.
    - `latest_observation_at` string, nullable, required
    - `engines` string[], required: Search engines with saved observations.
    - `devices` string[], required: Devices with saved observations.
    - `countries` string[], required: Countries with saved observations.
    - `locations` object[], required: Location filter keys with saved observations.
      - `key` string, required
      - `name` string, required
      - `country` string, required
  - `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)