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.

Returns every column Cometly has cached for the entity, including platform-specific creative and targeting snapshots. Replaces the legacy “dump the entire ads dataset into the prompt” pattern.

When to use

  • “Show me the full config for campaign 1100012345 on Facebook.”
  • “What targeting / creative is this ad using?”
For tabular lists, use list_campaigns, list_adsets, or list_ads.

Parameters

ParameterTypeRequiredDescription
sourcestringYesfacebook_ads, google_ads, tiktok_ads, or linkedin_ads.
levelstringYescampaign, adset, or ad.
idstringYesThe platform-side or Cometly id.
formatstringNojson (default), csv, or yaml.

Output

JSON object containing every column for the requested entity. Shape varies per platform / level. For Facebook ads, expect fields like objective, daily_budget, targeting, creative_id, creative_body, effective_status. For Google ads, expect advertising_channel_type, bidding_strategy_type, final_url, etc.

Caveats

  • LinkedIn ad sets don’t have a separate “adset” notion in Cometly’s model — only campaigns and creatives. level: adset for LinkedIn returns a [validation_error].
  • Reddit ads only support level: ad.