Back to documentation

White-label reports

Remove Adloom branding from PDF reports and replace it with your own company identity. Available on the Agency plan.

Overview

The Agency plan includes white-label PDF reports. When enabled, all Adloom branding is removed from individual creative reports and campaign aggregate reports. You can optionally inject your own company name and URL, which will appear in the header, footer, and filename.

Plan requirement: Agency plan ($599/month) or higher. White-label parameters are silently ignored on other plans.

What changes

When white-label mode is enabled, the following elements are modified in the generated PDF:

Header

The "adloom" logo text and "Creative Lab: Test Report" tagline are replaced. If you provide a company_name, it appears as the main title. If you provide a company_url, it replaces the tagline. If neither is provided, a neutral "Test Report" header is used.

Footer

The "Generated by Adloom Creative Lab (adloom.io)" footer is replaced. If you provide a company_name, the footer reads "Generated by [your company name]". If no company name is provided, the footer is removed entirely. Page numbers are always retained.

Filename

The default filename prefix "adloom-report" is replaced with your company name (lowercased, sanitised) or "report" if no company name is given. For example: myagency-banner300x250-2026-03-22.pdf.

How to use

Individual creative reports

Add query parameters to the report download URL:

GET /api/creatives/:id/report?white_label=true&company_name=My Agency&company_url=myagency.com

Campaign aggregate reports

The same parameters work on campaign reports:

GET /api/projects/:projectId/report?white_label=true&company_name=My Agency&company_url=myagency.com

Parameters

white_label (required)

Type: String

Set to true to enable white-label mode. Any other value or omission keeps the default Adloom branding.

company_name (optional)

Type: String

Your company or brand name. Appears in the report header, footer, and filename. If omitted, the header shows "Test Report" and the footer is removed.

company_url (optional)

Type: String

Your company website URL. Appears as the tagline beneath the company name in the report header.

Examples

Minimal white-label (remove branding only)

/api/creatives/abc123/report?white_label=true

Result: header shows "Test Report", no footer text, filename: report-mybanner-2026-03-22.pdf

Full custom branding

/api/creatives/abc123/report?white_label=true&company_name=MediaCorp&company_url=mediacorp.eu

Result: header shows "MediaCorp" with "mediacorp.eu", footer shows "Generated by MediaCorp", filename: mediacorp-mybanner-2026-03-22.pdf

Campaign report with branding

/api/projects/proj456/report?white_label=true&company_name=MediaCorp

Result: campaign aggregate PDF with MediaCorp branding on all pages