Projects

Create a project and start its first checks

Creates a project for one brand with the supplied default market and immediately queues its first checks, which use the on-demand allowance: keywords × locations checked per run × devices × search engines. Random check times are on unless randomize_check_times is false. The initial keywords use that market; later keyword batches can use another country and language. Plan limits on projects, keywords, locations and schedule apply, exactly as in the app. Requires the write scope and an idempotency key; repeating the key returns the same project without new checks. Confirm the details with the user before calling.

post/projects

Request

  • Base URL: https://adslighthouse.com/api/v1
  • URL: https://adslighthouse.com/api/v1/projects
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

A unique value you choose for this request, such as a UUID. Repeating the same key returns the first result instead of starting paid work again.

Request body

namestring required

Project name, such as Nike US.

brand_namestring required

The brand to monitor, such as Nike.

brand_domainsstring[] required

The brand's own domains. The first is the primary domain; ads from them count as yours.

countrystring required

Market to monitor, ISO 3166-1 alpha-2, such as US.

languagestring

Search language, such as en.

locations_per_runinteger nullable

How many of the locations each run checks, least recently checked first. null (the default) checks every location in every run.

devicesstring[]
search_enginesstring[]
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. The plan limits the most frequent schedule, and the full-month forecast must fit the scheduled check allowance.

randomize_check_timesboolean

Start each scheduled run at a random moment inside its interval. On by default; it never runs more often than the schedule.

keywordsstring[] required

Search terms to monitor, such as nike running shoes.

Response

Create a project and start its first checks

createdboolean required
request_idstring

Changes

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