smallforce ads insights query

Run a synchronous Meta Insights query

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

Complete command help

Usage: smallforce ads insights query [options] <targetId>

Run a synchronous Meta Insights query

Arguments:
  targetId                 SmallForce-local ad-account, campaign, ad-set, or advertisement id; raw
                           Meta ids are rejected

Options:
  --account <adAccountId>  Local id from ads accounts list
  --target-kind <kind>     ad_account, campaign, ad_set, or ad
  --input <json>           Inline JSON request object
  --input-file <path>      JSON request file; use - to read from stdin
  --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 insights: 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.