Skip to main content
Journey tools are designed to answer questions like “How is this campaign performing?” in one call, without chaining multiple low-level tools.
Journey report tools are read-only. They do not create, edit, pause, or delete campaigns/ads. Editing and ad-writing features are Coming Soon.

Common Inputs

All journey report tools accept:
  • A required date range: since and until (YYYY-MM-DD)
  • Optional comparison range: compare_since + compare_until (must be provided together)
  • Optional report shape controls:
    • preset (metric preset)
    • time_increment (daily/weekly, etc.)
    • breakdowns (age, country, placement, etc.)
    • detail_level (summary or full)
    • include_raw (includes raw platform payloads; can be large)
Usage limits may apply. See Pricing.

ads_campaign_report

What It Does

Generates a campaign performance report for a specific date range (with optional comparison and deltas).

When To Use It

Use this when the user asks:
  • “How is this campaign doing this week?”
  • “Compare this campaign to last week.”
  • “Break down campaign performance by day / country / placement.”

Inputs

ParameterTypeRequiredDescription
platformstringYesCurrently only meta is supported
campaign_idstringYesMeta campaign ID
sincestringYesStart date (YYYY-MM-DD)
untilstringYesEnd date (YYYY-MM-DD)
compare_sincestringNoComparison start date (YYYY-MM-DD)
compare_untilstringNoComparison end date (YYYY-MM-DD)
presetstringNoMetric preset (defaults to a performance-oriented preset)
time_incrementstringNoTime bucket size (e.g., daily)
breakdownsarrayNoSegment by dimensions (e.g., ["country"])
detail_levelstringNosummary or full
include_rawbooleanNoInclude raw platform payloads (can be large)

Output (Stable Fields)

FieldTypeDescription
successbooleanWhether the report was generated
toolstringTool name (ads_campaign_report)
tool_versionstringVersion tag (e.g., v1)
platformstringPlatform (meta)
entityobjectEntity metadata (campaign id/name/status, budget fields when available)
rangeobject{ since, until }
performanceobjectKPI + conversion summaries + record_count
seriesobjectOptional time series rows (when requested)
comparisonobjectOptional comparison range + deltas

Example Prompts

Generate a campaign report for campaign 123456789 since 2026-02-01 until 2026-02-07
Compare campaign 123456789 since 2026-02-01 until 2026-02-07 vs 2026-01-25 to 2026-01-31

Notes & Edge Cases

  • compare_since and compare_until must be provided together.
  • If you request time_increment or breakdowns, the tool may return series.rows and may truncate long result sets.
  • include_raw is intended for debugging and can produce large outputs.

ads_adset_report

What It Does

Generates an ad set performance report for a specific date range (with optional comparison and deltas).

When To Use It

Use this when the user asks:
  • “How is this ad set doing?”
  • “Which targeting segment is underperforming?”

Inputs

Same as ads_campaign_report, but with adset_id instead of campaign_id.

Output (Stable Fields)

Same envelope as ads_campaign_report, with tool: "ads_adset_report" and entity.type: "adset".

Example Prompts

Generate an ad set report for ad set 456789123 since 2026-02-01 until 2026-02-07

ads_ad_report

What It Does

Generates an “ad deep dive” report that includes:
  • Creative metadata (headline/body/link/media URLs when available)
  • Performance KPIs and conversions
  • Optional comparison deltas and a series breakdown

When To Use It

Use this when the user asks:
  • “How is this specific ad performing?”
  • “Compare this ad to last week.”
  • “Show performance by day/country and include the creative.”
If the user wants OCR text, labels, colors, or logos from the creative, use meta_analyze_ad_creative.

Inputs

Same as ads_campaign_report, but with ad_id instead of campaign_id.

Output (Stable Fields)

In addition to the shared envelope fields, ads_ad_report includes:
  • ad: compact ad metadata
  • creative: compact creative metadata (may include media URLs)

Example Prompts

Generate an ad report for ad 789123456 since 2026-02-01 until 2026-02-07