Reports

Your affiliate IDs seen in saved ad URLs

Lists the values of the project's affiliate URL parameter found in destination URLs of saved Google ads in the window and filters, as on the Affiliate IDs page: ads_observed (ad occurrences carrying the ID), advertiser domains, keywords and up to five example URLs. Names come from the project's affiliate directory. An ID in a URL does not prove who placed the ad or that a rule was broken; use list_affiliate_findings to narrow review to ads whose copy also used the brand, and keep the same date and observation filters when preparing evidence. configured is false and the list empty when no parameter is set.

get/projects/{project_id}/affiliate-ids

Request

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

Your affiliate IDs seen in saved ad URLs

configuredboolean required
url_parameterstring nullable required

The first tracked parameter's name. Kept for older clients; read url_parameters.

url_parametersstring[] required

Every tracked rule, as a name (fpr) or an exact name=value pair.

next_cursorstring nullable required

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

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.