Keywords

Monitored keywords with saved checks and ads in a window

Lists a project's keywords with their own country and language, which may differ from the project's default market. For each, checks_saved counts saved search result pages and ads_observed counts paid ad occurrences in the window and filters. ads_observed is not a count of unique advertisers. Defaults to the last 30 days.

get/projects/{project_id}/keywords

Request

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

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.

fromstring

First local day, YYYY-MM-DD (custom range).

tostring

Last local day, YYYY-MM-DD, included in full (custom range).

time_zonestring

IANA time zone for day boundaries, such as America/New_York. Defaults to the time zone of the person the credential acts for.

'google' | 'bing'
OR
string[]
'desktop' | 'mobile'
OR
string[]
'windows' | 'macos' | 'android' | 'ios' | 'unspecified'
OR
string[]
string
OR
string[]
string
OR
string[]
limitinteger

Items per page, 1 to 200.

cursorstring

The next_cursor value from the previous page. Omit it for the first page.

Response

Monitored keywords with saved checks and ads in a window

next_cursorstring nullable required

Pass as cursor to get the next page; null on the last page.

request_idstring

Changes

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