smallforce ads campaigns analytics

Get summary, daily, and optional breakdown analytics

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.7. Run smallforce ads campaigns analytics --help locally to view the same reference for your installed version.

Complete command help

Usage: smallforce ads campaigns analytics [options] <campaignId>

Get summary, daily, and optional breakdown analytics

Arguments:
  campaignId               Provider campaign id from campaigns list

Options:
  --account <adAccountId>  Local id from ads accounts list
  --platform <platform>    facebook or instagram
  --from <date>            Inclusive YYYY-MM-DD start date
  --to <date>              Inclusive YYYY-MM-DD end date
  --breakdown <dimension>  age, gender, country, publisher_platform, device_platform, or region;
                           repeatable (default: [])
  --api-key <key>          SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>      SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json                   Print stable machine-readable JSON
  --text                   Print human-readable text
  --format <format>        Output format: text or json
  -h, --help               display help for command

Related reference

• smallforce ads campaigns: Parent command and related operations.
• CLI installation and authentication: Install the CLI and configure an API key.
• CLI JSON output: Use stable machine-readable output in scripts and agents.