Reports

The rows of the Paid results CSV export, as JSON

Returns exactly the rows and columns of the Paid results CSV export for the same window, filters, keywords, segment, domain search, imported study and sort, paged as JSON. visibility is observations where the domain showed at least one ad / observations, with four decimals as in the CSV; it is not impression share. List values are joined with ' | ' as in the CSV. total_rows counts rows of the whole export before paging.

get/projects/{project_id}/exports/paid-results

Request

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

segment'all' | 'affiliate' | 'brand_mention' | 'coupon' | 'lookalike'

Segment tab of the Paid results table.

domain_containsstring

Keep domains that contain this text, like the domain search box.

study_idstring

Only this imported study; an unknown id returns no rows.

string
OR
string[]
sort'domain' | 'advertiser' | 'ads' | 'keywords' | 'visibility' | 'affiliates' | 'countries' | 'lastFound' | 'policy'
direction'asc' | 'desc'

Defaults to A to Z for text columns and largest first otherwise.

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

The rows of the Paid results CSV export, as JSON

next_cursorstring nullable required

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

total_rowsinteger required
observationsinteger required
notestring nullable required

A caution about sample size or configuration to repeat when reporting results.

request_idstring

Changes

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