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.

Enumerates every metric the analytics tools accept, with a short type tag and (for custom_event_* metrics) the configured human label. Call this before query_ad_metrics whenever you’re unsure of the canonical slug — saves a [validation_error] round-trip on misspellings.

​
When to use

  • Before composing a query_ad_metrics / query_metric_breakdown / query_ad_metrics_compare call when you’re not certain a metric slug exists.
  • To enumerate everything the user can ask for (“what metrics are available?”).

​
Parameters

ParameterTypeRequiredDescription
formatstringNocsv (default), json, or yaml.
include_unusedbooleanNoInclude custom_event_* slots without a configured label (default false).

​
Output

slug,category,label
amount_spent,ad,
purchase,conversion,
purchase_amount,conversion_amount,
roas,ad,
cost_per_purchase,cost_per_conversion,
custom_event_2,custom_event,Deal Created
cost_per_custom_event_2,cost_per_custom_event,Deal Created
custom_event_2_amount,custom_event_amount,Deal Created
category is one of: analytics, ad, meta, tiktok, linkedin, microsoft, conversion, cost_per_conversion, conversion_amount, conversion_roas, custom_event, cost_per_custom_event, custom_event_amount, custom_event_roas.
  • The cometly://catalog/metrics MCP Resource serves the same data.
  • For user-defined metric formulas, see list_user_defined_metrics.