Build a client report
build_report_linkLink to the analytics report laid out as a document — cover, executive summary and one section per page — ready to save as PDF from the browser. Pick the sections you want; sections with no data are skipped, so asking for more than exists never leaves a blank page. Sentiment only appears on Inferno, where brand listening lives. The same filters as the Analytics screen apply and are printed on the cover: one account and one network (platform). Saved competition analyses (the Competition tab history) can be appended with researchIds, up to 5; they are never included unless listed. The top-conversations table is never in the report: it names end customers.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| days | No | Window: 7, 30, 90, 180 or 365 (default 30). | |
| metrics | No | Lines drawn on the trend chart, as on the Analytics screen. Omit for the default (the first two metrics with data). Metrics with no data in the period are left out. | |
| language | No | Language of the PDF, independent of the app's (e.g. ru for an agency's Russian client). Omit for the workspace's saved one, else the app's. The workspace's report brand (an agency's logo, name and colour, set in the report dialog) is applied automatically. | |
| platform | No | One network only (e.g. instagram, tiktok, facebook). Must have a connected account in this workspace, otherwise the report ignores it. Omit for all networks. | |
| sections | No | Section ids, in any order. Available: kpis, trend, engagementEvolution, followers, audience, demographics, cadence, platforms, channels, gbp, stories, linkedin, topPosts, inboxKpis, inboxVolume, inboxResponse, inboxAuto, inboxAutomation, inboxDelivery, inboxAccounts, inboxPlatforms, inboxWhen, sentiment. Omit for the full report; pass an empty list for a report with only the competition analyses. | |
| accountId | No | One account only. Omit for all of them. | |
| researchIds | No | Ids of saved competition analyses to append, one section each (max 5). The research tools (research_account, research_niche, analyze_reel) return it as researchId; otherwise ask the human which analyses they want. One without results yet is shown with a note. | |
| workspaceId | No | Workspace to work on (an id from list_workspaces). Not needed when this connection is tied to one workspace, or when you pass an account: the account's workspace is used. |