Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cometly.com/llms.txt

Use this file to discover all available pages before exploring further.

Different from run_saved_report: that returns raw rows. This runs the same AI summarization pipeline that powers Cometly’s scheduled digests and returns the tuned narrative analysis.

Important — credit cost

This tool deducts AI credits from the team. It uses the same accounting as the Notification Subscription digest pipeline. Don’t call repeatedly with no user intent — one call per ask.

When to use

  • “Summarize my Q3 dashboard.”
  • “What’s the headline from last week’s report?”

When not to use

  • For ad-hoc analytics — use query_ad_metrics and analyze in your own reasoning.
  • When the team is out of credits — check via get_workspace_context.

Parameters

ParameterTypeRequiredDescription
report_idintegerYes

Output

Plain markdown text. Empty / error response when the team has zero credits or the provider is unavailable — pair with get_workspace_context.ai_credit_balance before calling.