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.

Runs the report with its stored attribution model, window, filters, sources, and group_by — exactly as the dashboard would show it. Trust the user’s saved config; for ad-hoc analysis with overrides, use query_ad_metrics directly.

​
Parameters

ParameterTypeRequiredDescription
report_idintegerYes
formatstringNojson (default), csv, or yaml.

​
Output

{
  "report_id": 42,
  "name": "ROAS by Source",
  "rows": [
    { "source": "facebook_ads", "roas": 3.82, "purchase": 412 },
    { "source": "google_ads",   "roas": 4.15, "purchase": 297 }
  ]
}
Custom event slot ids are rewritten to user labels in column names — # label_map: footer carries the mapping.