Reports

Request a project PDF report for a window and filters

Requests a PDF report of a project's saved observations: executive summary with period-over-period change, coverage and methodology, trends, top advertisers with presence and share, new and returning advertisers, brand mentions, affiliate findings, advertiser deep dives, ad copy, Shopping when enabled, and keyword and evidence appendices. Choose comparable windows with the same filters and time zone for a period comparison. It is generated in the background: poll get_report_status, then use get_report_download_link. Idempotent by selection: while a report for the same project, window, time zone, filters and branding is queued, running or ready, the same report is returned (created is false). With branding agency the PDF carries the account's report branding instead of ours; a branding change after a request makes the next request a new file. Each account can create 20 new reports per UTC day. The report states that observations are not proof of spend or infringement; repeat that when you share it. Defaults to the last 30 days.

post/projects/{project_id}/reports

Request

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

Request body

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.

branding'default' | 'agency'

default: our branding. agency: the account's report branding (get_report_branding) on the cover, headers, footers and file properties, with no mention of our name; needs a plan with white-label reports and branding set up.

prepared_forstring

With branding agency: the client name on the cover, up to 120 characters. Defaults to the project name. Part of the idempotency: another name makes another file.

Response

Request a project PDF report for a window and filters

createdboolean required

False when an existing report for this selection was returned.

request_idstring

Changes

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