---
title: "Generate an analytics PDF report"
method: POST
path: "/v1/workspaces/{workspaceId}/analytics/report/{provider}"
tags: ["Analytics"]
---

# Generate an analytics PDF report

`POST /v1/workspaces/{workspaceId}/analytics/report/{provider}`

## Request

- Base URL: `https://api.maevesocial.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.maevesocial.com/v1/workspaces/{workspaceId}/analytics/report/{provider}`
- Auth: HTTP bearer

## Path parameters

- `provider` string, required
- `workspaceId` string, uuid, required

## Request body

- GenerateReportDto
  - `startDate` string, nullable
  - `endDate` string, nullable
  - `integrationId` string, uuid, nullable: Compatibility field for launched single-account clients. New callers should send `integrationIds`; controllers merge both forms before service calls.
  - `integrationIds` string[], nullable: Multi-account aggregate path. All ids must belong to the same platform; the service rejects mixed-platform requests.
  - `adAccountId` string, uuid, nullable: Paid TikTok data is selected explicitly because advertiser accounts are deliberately separate from organic publishing integrations.
  - `adsCompare` 'none' | 'previous_period', nullable
  - `days` union
    - 'all'
    - integer
  - `titlePage` TitlePageOptionsDto
    - `enabled` boolean, required
    - `title` string, nullable
    - `description` string, nullable
  - `sections` SectionOptionsDto
    - `demographics` boolean, nullable
    - `topPosts` boolean, nullable
    - `labels` boolean, nullable
    - `ads` boolean, nullable
  - `analysis` AnalysisOptionsDto
    - `heading` string, nullable: Section heading, defaults to "Analysis". Rename to taste (e.g. "Notes").
    - `body` string, nullable: The analyst's written commentary, rendered as the closing section.

## Response `200`

PDF report

---

[API](https://skmtc.dev/maevesocial/apis/maeve-social-api.md) · [All operations](https://skmtc.dev/maevesocial/apis/maeve-social-api/llms.txt) · [OpenAPI document](https://skmtc.dev/maevesocial/apis/maeve-social-api/revisions/1b00fd7e4b15?raw)