FlumeLine API

Base URL: https://app.flumeline.com/api/v1. Every response is JSON unless you ask for CSV. Dates are YYYY-MM-DD in UTC. Percent fields are ratios, so 0.05 means 5%. Money is in each account's own currency.

Authentication

Create a key under API keys in your workspace. A key belongs to one workspace and is either read-only or allowed to publish. Send it as a bearer token:

curl "https://app.flumeline.com/api/v1/connectors" \
  -H "Authorization: Bearer YOUR_API_KEY"

Tools that cannot set headers can pass api_key=YOUR_API_KEY in the query string instead. Prefer the header: URLs end up in logs and browser history.

Querying data

GET https://app.flumeline.com/api/v1/{connector}?fields=...&date_preset=...

{connector} is a source id such as google_ads, or all to stack every connected ad platform into one table. For example, daily spend by campaign for last week:

curl "https://app.flumeline.com/api/v1/google_ads?fields=date,campaign,spend,clicks,ctr&date_preset=last_7d" \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "data": [
    { "date": "2026-11-09", "campaign": "Brand search", "spend": 184.2, "clicks": 412, "ctr": 0.0731 }
  ],
  "meta": {
    "connector": "google_ads", "table": "performance",
    "fields": ["date", "campaign", "spend", "clicks", "ctr"],
    "date_from": "2026-11-09", "date_to": "2026-11-15",
    "accounts": ["1234567890"], "rows": 1, "cached": false, "warnings": []
  }
}

A source can have several tables (for example Business Profile has reviews, performance, search keywords and posts). FlumeLine picks the table from the fields you ask for; fields from different tables need separate requests.

Parameters

ParameterMeaning
fieldsRequired. Comma-separated field ids, returned in this order.
date_presetOne of today, yesterday, last_7d, last_14d, last_28d, last_30d, last_90d, last_365d, this_month, last_month, this_year, last_year. Defaults to last_30d. The last_N ranges end yesterday.
date_from, date_toAn explicit inclusive range. Overrides date_preset.
accountsComma-separated account ids. Defaults to every account switched on for the source.
filterfield:operator:value, repeatable. Operators: eq, neq, contains, not_contains, gt, gte, lt, lte, in. Text matching ignores case. For in, separate values with |.
sortComma-separated field ids; prefix with - for descending. Defaults to date ascending when date is requested.
limitMaximum rows to return.
tableForce a table when you want to be explicit.
formatcsv returns a CSV file instead of JSON.
refreshtrue skips the cache and queries the source again.
# Campaigns containing "brand" that spent more than 50, biggest first
https://app.flumeline.com/api/v1/all?fields=source,campaign,spend,conversions&date_preset=last_month
  &filter=campaign:contains:brand&filter=spend:gt:50&sort=-spend

Listing sources, accounts and fields

GET /api/v1/connectors                 # every source, with connected account counts
GET /api/v1/{connector}/accounts       # account ids and names switched on for a source
GET /api/v1/{connector}/fields         # tables, fields and action parameters

Publishing and replying

Write actions change live public content, so they need a key created with publish access, on a plan that includes publishing. Send a POST with the account to act on and the action's parameters:

curl -X POST "https://app.flumeline.com/api/v1/google_business_profile/actions/create_post" \
  -H "Authorization: Bearer YOUR_WRITE_KEY" -H "Content-Type: application/json" \
  -d '{
    "account": "LOCATION_ID",
    "params": { "summary": "Open late this Saturday, until 9pm.", "cta_type": "LEARN_MORE", "cta_url": "https://example.com/hours" }
  }'
SourceActionParameters
google_business_profilecreate_postPublishes an update, event or offer on the location's Business Profile.summary (required), topic_type, cta_type, cta_url, media_url, event_title, event_start, event_end, coupon_code, redeem_url, terms, language_code
google_business_profiledelete_postRemoves a post from the location's Business Profile.post_id (required)
google_business_profilereply_to_reviewPosts or replaces the owner's public reply to a review.review_id (required), comment (required)
google_business_profiledelete_review_replyRemoves the owner's reply from a review.review_id (required)
facebook_organiccreate_postPublishes a text, link or photo post to the Page's feed.message, link, image_url
facebook_organicdelete_postDeletes a post from the Page.post_id (required)
instagramcreate_postPublishes a photo or a reel. Instagram does not accept text-only posts, so an image or video URL is required.image_url, video_url, caption
linkedin_organiccreate_postPublishes a text post to the Page's feed, optionally sharing an article link.text (required), link, link_title, link_description
linkedin_organicdelete_postDeletes a post published by the Page.post_id (required)

MCP server

The same workspace is available to AI assistants at https://app.flumeline.com/api/mcp (Streamable HTTP). Authenticate with the same API key as a bearer token, or add ?api_key= to the URL for clients that only take a URL. Tools: get_connectors, get_accounts, get_fields, get_data and execute_action.

claude mcp add --transport http flumeline https://app.flumeline.com/api/mcp \
  --header "Authorization: Bearer YOUR_API_KEY"

Errors and limits

Errors come back as { "error": { "code": "...", "message": "..." } } with a matching HTTP status. The message says what to change.

StatusCodeWhat happened
400unknown_field, incompatible_fields, invalid_date…The request needs fixing.
401unauthorizedThe API key is missing, wrong or revoked.
401reauth_requiredA source login expired or was revoked. Reconnect it in the workspace.
402plan_upgrade_requiredThe plan does not include publishing.
403write_scope_requiredA read-only key tried to run an action.
409no_accountsNo accounts are switched on for that source.
429quota_exceeded, upstream_rate_limitedThe monthly request allowance is used up, or the source is rate limiting.
502, 504upstream_error, upstream_timeoutThe source itself failed or was too slow. Try a shorter date range.

Results are cached for a few minutes (how long depends on the plan), and meta.cached tells you when a response came from cache. Every request counts toward the monthly allowance, cached or not.

Sources and fields

All ad platforms all

Stacks every connected ad platform. Fields: source, account_id, account_name, date, campaign, campaign_id, currency, impressions, clicks, spend, conversions, conversion_value, ctr, cpc, cpm, cost_per_conversion, roas.

Google Analytics 4 googleanalytics4

Sessions, users, events, key events and revenue by channel, page, device and geography.

Report (report)

Any compatible combination of GA4 dimensions and metrics (up to 9 dimensions and 10 metrics per request).

Dimensions: source, account_id, account_name, date, session_source, session_medium, session_campaign, channel_group, country, city, device_category, page_path, page_title, landing_page, event_name, hostname

Metrics: sessions, users, new_users, active_users, engaged_sessions, pageviews, events, key_events, revenue, transactions, engagement_seconds, engagement_rate, views_per_session

Google Ads google_ads

Spend, clicks, impressions and conversions by campaign, ad group, keyword and device.

Performance (performance)

Account, campaign, ad group or keyword performance. The grain follows the dimensions you request.

Dimensions: source, account_id, account_name, date, campaign, campaign_id, campaign_status, campaign_type, ad_group, ad_group_id, ad_group_status, keyword, keyword_match_type, device, currency

Metrics: impressions, clicks, spend, conversions, conversion_value, all_conversions, interactions, ctr, cpc, cpm, cost_per_conversion, conversion_rate, roas

Meta Ads facebook

Facebook and Instagram ad spend, reach, clicks, purchases and leads by campaign, ad set, ad and audience breakdown.

Ad insights (insights)

Performance at account, campaign, ad set or ad level. The level follows the dimensions you request.

Dimensions: source, account_id, account_name, date, campaign, campaign_id, objective, adset, adset_id, ad, ad_id, country, age, gender, publisher_platform, device_platform, currency

Metrics: impressions, clicks, spend, reach, link_clicks, purchases, leads, conversions, conversion_value, ctr, cpc, cpm, cost_per_conversion, conversion_rate, roas

LinkedIn Ads linkedin

Campaign spend, clicks, impressions, leads and conversions from LinkedIn Campaign Manager.

Ad analytics (ad_analytics)

Performance by account, campaign or creative. Creative-level and campaign-level dimensions cannot be mixed.

Dimensions: source, account_id, account_name, date, campaign, campaign_id, campaign_status, campaign_type, campaign_group_id, creative_id, currency

Metrics: impressions, clicks, spend, conversions, conversion_value, leads, landing_page_clicks, likes, comments, shares, follows, video_views, total_engagements, ctr, cpc, cpm, cost_per_conversion, conversion_rate, roas

Search Ads 360 search_ads_360

Cross-engine search campaign performance from the Search Ads 360 Reporting API.

Performance (performance)

Account, campaign, ad group or keyword performance. The grain follows the dimensions you request.

Dimensions: source, account_id, account_name, date, campaign, campaign_id, campaign_status, campaign_type, ad_group, ad_group_id, ad_group_status, keyword, keyword_match_type, device, currency

Metrics: impressions, clicks, spend, conversions, conversion_value, all_conversions, interactions, ctr, cpc, cpm, cost_per_conversion, conversion_rate, roas

Google Ad Manager google_ad_manager

Publisher impressions, clicks and revenue by ad unit, advertiser, order, line item, country and device.

Historical report (report)

Runs an Ad Manager historical report. Reports run asynchronously on Google's side, so large ranges can take up to a minute.

Dimensions: source, account_id, account_name, date, ad_unit, advertiser, order, line_item, line_item_type, creative, country, device_category

Metrics: impressions, clicks, revenue, ad_server_impressions, ad_server_clicks, ad_server_revenue, ad_exchange_impressions, ad_exchange_revenue, adsense_impressions, adsense_revenue, ctr, ecpm

Google Search Console google_search_console

Organic clicks, impressions, CTR and average position by query, page, country and device.

Search analytics (search_analytics)

Search performance. CTR and position are calculated by Google for the dimensions requested.

Dimensions: source, account_id, account_name, date, query, page, country, device, search_appearance

Metrics: clicks, impressions, ctr, position

Sitemaps (sitemaps, current snapshot, no date range)

Submitted sitemaps with their last download time, errors and warnings.

Dimensions: source, account_id, account_name, sitemap_path, sitemap_type, sitemap_last_submitted, sitemap_last_downloaded, sitemap_is_pending

Metrics: sitemap_errors, sitemap_warnings, sitemap_submitted_urls

PageSpeed Insights google_pagespeed

Lighthouse scores and Core Web Vitals (lab and real-user field data) for the page URLs you add.

Page audit (audit, current snapshot, no date range)

A fresh Lighthouse run per URL. Returns the mobile result; request the strategy field to get mobile and desktop rows. Each run takes 10–30 seconds, so results are cached for six hours.

Dimensions: source, account_id, account_name, url, strategy, date, field_overall_category

Metrics: performance_score, accessibility_score, best_practices_score, seo_score, lcp_ms, fcp_ms, cls, tbt_ms, speed_index_ms, ttfb_ms, field_lcp_ms, field_inp_ms, field_cls, field_fcp_ms, field_ttfb_ms

Google Business Profile google_business_profile

Reviews, Search and Maps performance, search keywords and posts for each location — plus publishing posts and replying to reviews.

Reviews (reviews)

One row per review created in the date range, with the owner's reply if there is one.

Dimensions: source, account_id, account_name, date, review_id, reviewer_name, review_comment, review_created_at, review_updated_at, review_reply, review_reply_updated_at, has_reply, location_address, new_review_url

Metrics: star_rating, location_average_rating, location_total_reviews

Performance (performance)

Daily Search and Maps impressions and customer actions from the Business Profile Performance API.

Dimensions: source, account_id, account_name, date

Metrics: impressions_desktop_maps, impressions_desktop_search, impressions_mobile_maps, impressions_mobile_search, call_clicks, website_clicks, direction_requests, conversations, bookings, food_orders, food_menu_clicks, impressions

Search keywords (search_keywords)

Monthly search terms that showed the profile. Google reports whole months and hides low-volume terms behind a threshold.

Dimensions: source, account_id, account_name, search_keyword, month, keyword_impressions_is_threshold

Metrics: keyword_impressions

Posts (posts, current snapshot, no date range)

Posts published on the profile (updates, events and offers).

Dimensions: source, account_id, account_name, post_id, post_summary, post_topic_type, post_state, post_created_at, post_updated_at, post_url, post_cta_type, post_cta_url, post_media_url, post_event_title

Facebook Pages facebook_organic

Page views, viewers, follows and engagement by day, plus each post with its reactions, comments, shares and views.

Page insights (page_insights)

Daily Page metrics. Meta replaced impressions and reach with views and unique viewers during 2025–2026.

Dimensions: source, account_id, account_name, date

Metrics: page_views, page_unique_viewers, page_post_engagements, page_follows_total, page_daily_follows, page_daily_unfollows, page_visits, page_video_views

Posts (posts)

Posts published in the date range with their engagement.

Dimensions: source, account_id, account_name, date, post_id, post_message, post_created_at, post_permalink, post_type

Metrics: post_reactions, post_comments, post_shares, post_views

Instagram instagram

Instagram professional account reach, follower growth and media engagement — plus publishing photos and reels to the feed.

Daily insights (daily_insights)

Daily reach and new followers. Instagram only keeps new-follower history for the last 30 days.

Dimensions: source, account_id, account_name, date

Metrics: reach, new_followers

Profile (profile, current snapshot, no date range)

Current follower, following and media counts.

Dimensions: source, account_id, account_name, username, profile_name

Metrics: followers, following, media_count

Media (media)

Posts and reels published in the date range with likes and comments.

Dimensions: source, account_id, account_name, date, media_id, media_caption, media_type, media_product_type, media_permalink, media_published_at

Metrics: media_likes, media_comments

LinkedIn Pages linkedin_organic

Company Page impressions, engagement, follower growth and page views by day, plus each post's performance.

Page statistics (page_stats)

Daily organic post performance, follower gains and page views. LinkedIn keeps daily history for 12 months.

Dimensions: source, account_id, account_name, date

Metrics: impressions, unique_impressions, clicks, likes, comments, shares, organic_follower_gain, paid_follower_gain, page_views, followers_total, engagement_rate

Posts (posts)

Posts published by the Page in the date range, with lifetime performance.

Dimensions: source, account_id, account_name, date, post_id, post_text, post_published_at, post_state

Metrics: post_impressions, post_clicks, post_likes, post_comments, post_shares

Google Merchant Center google_merchant

Product listing clicks and impressions, plus each product's price, availability and approval status.

Product performance (product_performance)

Clicks and impressions for free listings and Shopping ads, by product, brand, country and day.

Dimensions: source, account_id, account_name, date, offer_id, product_title, brand, country, marketing_method, category_l1, product_type_l1

Metrics: clicks, impressions, conversions, conversion_value, ctr

Products (products, current snapshot, no date range)

The current product catalogue with price, availability and approval status.

Dimensions: source, account_id, account_name, product_id, offer_id, product_title, brand, product_availability, product_condition, product_status, product_language, product_feed_label, product_click_potential, product_created_at, product_currency

Metrics: product_price

Shopify shopify

Orders, daily sales, products and customers from a Shopify store.

Sales by day (sales)

Orders summed by day (or over the whole range when date is not requested).

Dimensions: source, account_id, account_name, date, currency

Metrics: orders, items, total_sales, subtotal, tax, discounts, shipping, refunds, average_order_value

Orders (orders)

One row per order created in the date range.

Dimensions: source, account_id, account_name, date, order_id, order_name, order_created_at, financial_status, fulfillment_status, currency

Metrics: items, total_sales, subtotal, tax, discounts, shipping, refunds

Products (products, current snapshot, no date range)

The current product catalogue.

Dimensions: source, account_id, account_name, product_id, product_title, product_vendor, product_type, product_status, product_handle, product_created_at

Metrics: product_inventory, product_price_min, product_price_max

Customers (customers)

Customers created in the date range with their lifetime orders and spend. Names and emails are not requested.

Dimensions: source, account_id, account_name, date, customer_id, customer_created_at, currency

Metrics: customer_orders, customer_total_spent

Amazon Seller Central amazon_seller_central

Daily units, orders and revenue per marketplace, individual orders and FBA inventory from the Selling Partner API.

Sales by day (sales)

Daily order metrics for the marketplace from the Sales API.

Dimensions: source, account_id, account_name, date, currency

Metrics: units, order_items, orders, revenue, average_order_value, average_unit_price

Orders (orders)

One row per order created in the date range. Amazon rate-limits this API heavily, so at most 2,000 orders are returned per request.

Dimensions: source, account_id, account_name, date, order_id, order_purchased_at, order_status, fulfillment_channel, sales_channel, currency

Metrics: order_total, items_shipped, items_unshipped

FBA inventory (inventory, current snapshot, no date range)

Current Fulfillment by Amazon stock per SKU.

Dimensions: source, account_id, account_name, sku, asin, fn_sku, product_name, condition

Metrics: quantity_total, quantity_fulfillable, quantity_inbound, quantity_reserved, quantity_unfulfillable

GoHighLevel gohighlevel

Contacts, pipeline opportunities and appointments from a HighLevel sub-account.

Contacts (contacts)

Contacts added in the date range.

Dimensions: source, account_id, account_name, date, contact_id, contact_name, contact_email, contact_phone, contact_source, contact_type, contact_tags, contact_city, contact_country, contact_date_added

Metrics: contacts

Opportunities (opportunities)

Pipeline opportunities created in the date range, with pipeline and stage names.

Dimensions: source, account_id, account_name, date, opportunity_id, opportunity_name, opportunity_status, opportunity_source, pipeline, pipeline_stage, opportunity_contact_id, opportunity_assigned_to, opportunity_created_at, opportunity_updated_at

Metrics: opportunities, opportunity_value

Appointments (appointments)

Calendar appointments that start in the date range, across every calendar in the sub-account.

Dimensions: source, account_id, account_name, date, appointment_id, appointment_title, appointment_status, appointment_calendar, appointment_contact_id, appointment_start_time, appointment_end_time

Metrics: appointments