Docs / Cli

smallforce ads campaigns tree

Read campaigns with nested ad sets and advertisements

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

Complete command help

Usage: smallforce ads campaigns tree [options]

Read campaigns with nested ad sets and advertisements

Options:
  --account <adAccountId>  Local id from ads accounts list
  --platform <platform>    facebook or instagram
  --status <status>        Campaign status filter
  --source <source>        all or zernio (default: "all")
  --from <date>            Inclusive YYYY-MM-DD start date
  --to <date>              Inclusive YYYY-MM-DD end date
  --page <n>               Page number, starting at 1
  --limit <n>              Campaigns per page, 1 to 100
  --campaign <campaignId>  Limit to one provider campaign id
  --include-daily          Include daily metric rows
  --daily-level <level>    campaign, adset, or ad
  --sort <sort>            newest, oldest, spend_desc, or spend_asc
  --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