Projects

Change a project's monitoring plan, brand or affiliate settings

Changes any of a project's settings, like Settings > Project: name, market (country and language), locations and how many each run checks (locations_per_run), devices, search engines, Shopping, schedule (monitoring_frequency, from daily to every_15_minutes; manual pauses scheduled monitoring, another value resumes it), random check times (randomize_check_times), brand name and owned domains, and the affiliate URL parameter with its registered affiliate IDs. Omitted fields keep their value; list fields replace the whole list. Coverage changes (keywords × locations checked per run × devices × sources × runs per day) are checked against the plan's limits and the account's full-month scheduled check allowance before they are saved; a change that does not fit returns quota_exceeded with the checks it needs and the allowance, and nothing changes. Call preview_check_demand first to show the user the effect. No check starts now: new coverage applies to the next scheduled runs. Saved observations are never rewritten. Requires the write scope.

patch/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.

Request body

namestring

Project name, such as Nike US.

countrystring

Market, ISO 3166-1 alpha-2 such as US. Changing it without locations monitors the whole new country.

languagestring

Search language, such as en.

locations_per_runinteger nullable

How many of the listed locations each run checks, least recently checked first, so the whole list is covered over time. null, or a number at or above the list size, checks every location in every run. Counts against the plan's locations_per_project and the check forecast. Omit to keep the current value.

randomize_check_timesboolean

Start each scheduled run at a random moment inside its interval (for Every hour, once in each UTC hour). It never runs more often than the fixed schedule and uses the same checks. Omit to keep the current value.

devicesstring[]

The full list of devices to check.

search_enginesstring[]

The full list of search engines. May be empty only when shopping_enabled is true. The market must offer each engine (get_monitoring_options).

shopping_enabledboolean

Also check Google Shopping ads. Needs a plan that includes Shopping and a market with Google.

monitoring_frequency'manual' | 'daily' | 'twice_daily' | 'four_times_daily' | 'six_times_daily' | 'twelve_times_daily' | 'hourly' | 'every_30_minutes' | 'every_15_minutes'

How often scheduled checks run, from daily to every_15_minutes. manual pauses scheduled monitoring (on-demand checks still work); any other value resumes it. The plan limits the most frequent schedule (allowed_on_plan in get_monitoring_options), and the account's full-month forecast must fit its scheduled check allowance.

brand_namestring

The brand to monitor, such as Nike.

owned_domainsstring[]

The full list of the brand's own domains; the first is the primary domain. Ads from these domains and their subdomains count as the brand's own.

affiliate_parameterstring nullable

Older single-parameter form: one parameter name, such as affiliate_id, replacing every tracked parameter. null or an empty string turns affiliate identification off. Prefer affiliate_parameters.

affiliate_parametersstring[]

The full list of tracked affiliate parameters, replacing the current list. Each is a name, such as fpr (any value in the URL is the affiliate ID), or name=value, such as utm_source=partners (only that exact value). An empty list turns affiliate identification off. Do not send full URLs.

Response

Change a project's monitoring plan, brand or affiliate settings

updatedstring[] required

Which settings groups were saved.

request_idstring

Changes

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