Flyweel

Get OAuth URL to connect Google Ads, Meta Ads, or TikTok Ads. Requires 'provider'. Returns URL user must visit.

Check which ad platforms are connected. Optional 'provider' filter ('google'/'meta'/'tiktok').

Get the user's setup status including which ad platforms are connected, which accounts are selected, and whether data has been synced. Returns recommended next steps.

Check sync job progress. Optional 'provider' filter ('google'/'meta'/'tiktok').

Get account status including connection status, accounts, and last sync time. Optional 'provider' ('google'/'meta'/'tiktok') - omit to get all providers in one call.

Run flexible analytics queries across ads and CRM data. Supports arbitrary metrics, dimensions (group by), filters, date presets, ordering, and limits. Send 1-5 queries per request. ## ADS Data **Metrics:** - spend: Total advertising spend (currency) - impressions: Total ad impressions (times ad was shown) (number) - clicks: Total ad clicks (number) - conversions: Total tracked conversions — what counts as a conversion depends on the campaign objective (app installs, purchases, leads, etc.). Use the 'objective' dimension to distinguish. (number) - reach: Total unique users reached (number) - ctr: Click-through rate (clicks / impressions * 100) (percentage) - cpc: Cost per click (currency) - cpm: Cost per 1000 impressions (currency) - conversion_rate: Conversion rate (conversions / clicks * 100) (percentage) - cost_per_conversion: Cost per conversion (currency) **Dimensions (group by):** - channel: Ad platform (Google, Meta, TikTok) - account: Ad account name (e.g., Carmico, DLCT) - campaign: Campaign name - campaign_id: Campaign ID - campaign_status: Campaign status (ENABLED, PAUSED, etc.) - objective: Campaign objective/goal — determines what 'conversions' measures (e.g., OUTCOME_APP_PROMOTION = app installs, OUTCOME_SALES = purchases, OUTCOME_LEADS = leads, MAXIMIZE_CONVERSIONS for Google, TRAFFIC/VIDEO_VIEWS/PRODUCT_SALES for TikTok). Critical context for interpreting conversion metrics. - currency: Account currency code (USD, AUD, EUR, etc.) - date: Date of the metrics - week: Week (grouped) - month: Month (grouped) ## CRM Data **Metrics:** - deals_created: Number of deals created (number) - deals_won: Number of deals marked as won (number) - deals_lost: Number of deals marked as lost (number) - deals_open: Number of deals still in progress (not won or lost) (number) - revenue: Total revenue from won deals (currency) - pipeline_value: Total value of all deals in pipeline (currency) - expected_value: Total expected amount of deals (currency) - avg_deal_size: Average deal size (currency) - avg_won_deal_size: Average size of won deals (currency) - win_rate: Percentage of closed deals that were won (percentage) - velocity_days: Average days from deal creation to close (days) **Dimensions (group by):** - stage: Current deal stage name - pipeline_id: Pipeline ID - lead_source: Where the lead came from (as reported in CRM) - source_channel: Lead source grouped into channels (Google, Meta, etc.) - deal_status: Deal outcome status (won, lost, open) - created_date: Date deal was created - created_week: Week deal was created - created_month: Month deal was created - close_date: Date deal was closed **Date range presets:** today, yesterday, last_7_days, last_14_days, last_30_days, last_60_days, last_90_days, this_week, last_week, this_month, last_month, this_quarter, last_quarter, this_year, last_12_months Or use explicit start/end dates (YYYY-MM-DD). **Extended metrics:** Extended platform metrics (e.g., frequency, video_trueview_views, purchases, leads) are always available. Use the exact key name as a metric name. **Example:** { "queries": [{ "dataSource": "ads", "metrics": ["spend", "clicks", "ctr"], "dimensions": ["channel"], "dateRange": { "preset": "last_30_days" } }] }

Select or deselect ad accounts for data syncing and analysis. Requires 'provider' ('google'/'meta'/'tiktok') and 'accountSelections' array with accountId and isSelected. This updates only the user's Flyweel account-selection state; it does not delete accounts, credentials, campaigns, or metrics.

Start syncing campaign data. Requires 'provider' ('google'/'meta'/'tiktok'). Must have accounts selected first.