Case actions

Request a PDF of one case for legal teams, networks or a complaint

Requests an evidence pack PDF for one case: case summary, each observation (search term, engine, location, device, local time with the time zone named, ad copy, display and destination URLs, affiliate parameters, redirect chain when traced), results-page screenshots and landing previews for the newest observations when available (it says when they are not), the case history and notes, and a methodology and limits note. It lists at most the 100 newest observations and says how many were left out. Generated in the background: poll get_case_evidence_pack, then use get_case_evidence_pack_download_link. Idempotent: while a pack for the case as it is now (same observations and timeline), the same time zone and the same branding is queued, running or ready, it is returned (created false). With branding agency the PDF carries the account's report branding instead of ours. Each account can create 30 new packs per UTC day; same plan requirement as PDF reports. An observation shows an ad was displayed for a search at a moment; it does not prove a purchased keyword, spend or infringement.

post/projects/{project_id}/evidence-packs

Request

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

case_type'policy' | 'affiliate' required

policy for a case from list_policy_cases; affiliate for a non-compliant affiliate case from list_affiliate_findings.

case_idstring

The policy case id. Required when case_type is policy.

affiliate_idstring

The affiliate ID exactly as list_affiliate_findings returns it. Required when case_type is affiliate.

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 PDF of one case for legal teams, networks or a complaint

createdboolean required
request_idstring

Changes

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