Developer · API reference

Reports

Read and edit shareable analytics reports and white-label branding.

Reports are the shareable, white-labelled analytics summaries you can generate for a company. These endpoints read and update a report and its branding.

GET /reports/branding

Get Branding

Return the company's global agency-branding row, or empty defaults.

🔒 Requires Authorization: Bearer ll_… (or X-API-Key).

Query parameters

Name	Type	Required	Default	Description
`company_id`	string	Yes	—	—

Example request

curl -X GET "https://api.lunalift.ai/reports/branding?company_id=VALUE" \
  -H "Authorization: Bearer ll_your_api_key"

Response · 200 OK

Field	Type	Notes
`company_id`	string	—
`logo_url`	string \| null	—
`accent`	string \| null	—
`agency_name`	string \| null	—

PUT /reports/branding

Put Branding

Upsert the ONE global agency-branding row. Logo is base64 JSON; decoded + stored in DO Spaces under reports/branding/{company_id}/, URL persisted.

🔒 Requires Authorization: Bearer ll_… (or X-API-Key).

Query parameters

Name	Type	Required	Default	Description
`company_id`	string	Yes	—	—

Request body· BrandingUpsert

Field	Type	Required	Description
`accent`	string \| null	No	—
`agency_name`	string \| null	No	—
`logo_base64`	string \| null	No	—
`logo_content_type`	string	No	—

Example request

curl -X PUT "https://api.lunalift.ai/reports/branding?company_id=VALUE" \
  -H "Authorization: Bearer ll_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "accent": "string",
  "agency_name": "string",
  "logo_base64": "string",
  "logo_content_type": "string"
}'

Response · 200 OK

Field	Type	Notes
`company_id`	string	—
`logo_url`	string \| null	—
`accent`	string \| null	—
`agency_name`	string \| null	—

GET /reports/{report_id}

Get Report

🔒 Requires Authorization: Bearer ll_… (or X-API-Key).

Path parameters

Name	Type	Required	Description
`report_id`	string	Yes	—

Example request

curl -X GET "https://api.lunalift.ai/reports/REPORT_ID" \
  -H "Authorization: Bearer ll_your_api_key"

Response · 200 OK

Field	Type	Notes
`id`	string	—
`company_id`	string	—
`created_by`	string \| null	—
`report_type`	ReportType	—
`status`	ReportStatus	—
`title`	string	—
`slug`	string	—
`spec_json`	ReportSpec-Output	The versioned snapshot. The renderer MUST handle every shipped ``spec_version`` — old shared ``/r/[token]`` links must never break.
`white_label_json`	WhiteLabel	Snapshot of the agency branding shown on THIS report. Seeded at generation time from the company's ``report_branding`` row + active ``Plan.partner_tier``. Per-report override via PATCH is allowed but global is always the default. There is NO cobranding-removal/hide field — the "powered by LunaLift" mark is hard-rendered by every renderer/exporter.
`created_at`	string	—
`updated_at`	string	—

PATCH /reports/{report_id}

Patch Report

Writable subset is EXACTLY {title, white_label_json, spec_json}. ``status`` is server-managed and rejected at the model boundary (extra fields forbidden).

🔒 Requires Authorization: Bearer ll_… (or X-API-Key).

Path parameters

Name	Type	Required	Description
`report_id`	string	Yes	—

Request body· ReportPatch

Field	Type	Required	Description
`title`	string \| null	No	—
`white_label_json`	WhiteLabel \| null	No	—
`spec_json`	ReportSpec-Input \| null	No	—

Example request

curl -X PATCH "https://api.lunalift.ai/reports/REPORT_ID" \
  -H "Authorization: Bearer ll_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "string",
  "white_label_json": {},
  "spec_json": {}
}'

Response · 200 OK

Field	Type	Notes
`id`	string	—
`company_id`	string	—
`created_by`	string \| null	—
`report_type`	ReportType	—
`status`	ReportStatus	—
`title`	string	—
`slug`	string	—
`spec_json`	ReportSpec-Output	The versioned snapshot. The renderer MUST handle every shipped ``spec_version`` — old shared ``/r/[token]`` links must never break.
`white_label_json`	WhiteLabel	Snapshot of the agency branding shown on THIS report. Seeded at generation time from the company's ``report_branding`` row + active ``Plan.partner_tier``. Per-report override via PATCH is allowed but global is always the default. There is NO cobranding-removal/hide field — the "powered by LunaLift" mark is hard-rendered by every renderer/exporter.
`created_at`	string	—
`updated_at`	string	—