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.

Lists every User-Defined Metric the space has set up — formulas the user composed in the report builder, like Profit Margin = (gross_revenue - amount_spent) / gross_revenue. These behave like first-class metric slugs in query_ad_metrics.

​
When to use

  • The user references a metric name that isn’t in the standard catalog (“show my LTV efficiency metric”). Confirm the slug exists here before passing it to an analytics tool.
  • To enumerate every space-defined calculation as part of an overview.

​
Parameters

ParameterTypeRequiredDescription
formatstringNocsv (default), json, or yaml.

​
Output

id,slug,name,type,expression
12,profit_margin,Profit Margin,percent,( gross_revenue - amount_spent ) / gross_revenue
17,ltv_efficiency,LTV Efficiency,number,ltv / amount_spent
type is one of number, currency, or percent. expression is a human-readable rendering of the formula tokens (order matters for the calculation).