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.

One call returns matching entities across every searchable kind in the space. Use when the user mentions something by name and you need its id before calling a more specific tool.

​
When to use

  • “Pull up the TikTok Q3 Launch campaign.” → search, find the id, then get_ad_entity.
  • “Find the dashboard called ‘Weekly Performance’.” → search → get_dashboard.
  • “Look up contact taylor@example.com.” → search → get_contact.

​
Parameters

ParameterTypeRequiredDescription
querystringYesThe search needle. Case-insensitive substring match. Minimum 2 characters.
kindsstring[]NoEntity kinds to include: ad_account, campaign, adset, ad, contact, company, report, dashboard. Default: all.
limitintegerNoMax rows per kind (1–25, default 5).
formatstringNocsv (default), json, or yaml.

​
Output

kind,id,name,extras
ad_account,act_1234567890,Acme Meta,source=facebook_ads
campaign,1100012345,Acme Spring Launch,source=facebook_ads
campaign,1100098765,Acme Spring - Display,source=google_ads
contact,8231,Taylor Swift,email=taylor@example.com
report,42,Weekly Performance,
dashboard,12,Q1 Snapshot,
extras is kind-specific context (source for ad entities, email for contacts). Use kind + id to call the appropriate detail tool — get_ad_entity for ad entities, get_contact for contacts, get_dashboard for dashboards, etc.

​
Caveats

This is a substring match over the canonical name column — it doesn’t reach into custom field values or message bodies. For those, use the specific list_* tool with filters.