Projects

One project's configuration and data coverage

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.

get/projects/{project_id}

Request

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

Response

One project's configuration and data coverage

idstring required
namestring required
countrystring required

ISO 3166-1 alpha-2 market code.

languagestring required
search_enginesstring[] required
devicesstring[] required
shopping_enabledboolean 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_dayinteger required
randomize_check_timesboolean required

Each scheduled run starts at a random moment inside its interval.

locations_per_runinteger 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_atstring required
owned_domainsstring[] required
keyword_countinteger required
active_keyword_countinteger required
request_idstring

Changes

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