The rows of the Paid results By keyword view, as JSON
Returns the Paid results By keyword table for the window and filters, one row per searched keyword, busiest first, paged as JSON. checks = saved observations of the keyword; checks_with_ads = those with at least one paid ad; ads_observed = paid ad occurrences; advertisers = distinct advertiser domains, listed busiest first; your_visibility = checks where one of your own domains showed an ad / checks, with four decimals, empty when the keyword has no checks. It is not impression share. Every monitored keyword appears even without checks in the window, so no checks stays distinct from no ads; markets lists its saved countries and is empty for a keyword that is no longer monitored or only imported. Includes imported studies unless engine or country filters are set.
Request
- Base URL: https://adslighthouse.com/api/v1
- URL: https://adslighthouse.com/api/v1/projects/{project_id}/exports/paid-results-by-keyword
- Auth: HTTP bearer
Path parameters
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
Only this imported study; an unknown id returns no observations.
Window ending today: 7d, 14d, 30d (default) or 12m. Use custom with from and to for fixed dates.
First local day, YYYY-MM-DD (custom range).
Last local day, YYYY-MM-DD, included in full (custom range).
IANA time zone for day boundaries, such as America/New_York. Defaults to the time zone of the person the credential acts for.
Items per page, 1 to 200.
The next_cursor value from the previous page. Omit it for the first page.
Response
The rows of the Paid results By keyword view, as JSON
Changes
No recorded changes to this operation across all 1 revision of this API.