List feeds
List feeds available to the calling organization.
query Parameters
searchFree-text search against feed description or id.
pagePage number (1-indexed).
page_sizeResults per page (max 100).
List feeds › Responses
Successful Response
totalTotal number of feeds matching the current query before pagination.
pageCurrent page number, 1-indexed.
page_sizeMaximum feeds per page.
total_pagesTotal pages for the current query.
Get a feed
Get one enabled feed by exact id for the calling organization.
path Parameters
feed_idGet a feed › Responses
Successful Response
iddescriptioncreated_atWhen the feed was first provisioned. Surfaced so the dashboard can sort / display feeds by recency without a second round-trip.
output_typeMaximum lookback window allowed for this feed for this org, in days. null means no explicit cap is configured.
Lifetime cap on the number of rows that can be exported from this feed. null means the feed is uncapped.
Rows already consumed from the export quota. null when the feed is uncapped.
Rows still available to export. Equal to max(0, export_row_limit - export_rows_used). null when the feed is uncapped.
Get feed stats
Get stats for one of your feeds.
Returns feed totals (and an optional daily breakdown when
include_daily_counts=true).
Two-step shortcut: include an auto_export object in the
request to also create a paginated export in the same call. The
response then carries an export field whose export_id you can
feed straight to POST /intent/feeds/exports/page, collapsing the
standard three-step flow (stats → create export → page) into two
round-trips (stats-and-export → page). Without auto_export, this
request is read-only — to export the same window, call
POST /intent/feeds/exports with the same feed_id and
lookback_days.
Get feed stats › Request Body
feed_idID of the feed to query. Must be a feed your organization can access.
lookback_daysSize of the rolling window in days, ending today (inclusive). A value of 14 returns exactly 14 inclusive data dates. Capped per feed by your organization's configured maximum; requests above the cap are rejected with 403.
include_daily_countsWhen true, the response includes a daily_counts array with one entry per day in the window. Useful for charts and trend displays. Off by default to keep responses small.
Set to also create a paginated export from the same stats request and include its summary in the response. When provided, the response's export field carries an ExportSummary whose export_id you can pass straight to POST /intent/feeds/exports/page. Omit this field to use the standard two-step flow (call POST /intent/feeds/exports yourself with the same feed_id and lookback_days).
Get feed stats › Responses
Successful Response
feed_idtotal_recordsTotal number of records matched in the window.
lookback_daysWindow size used by the stats request.
records_with_contact_idRecords that resolve to a contact_id — a stable contact identifier you can use with the enrichment APIs. Use this to size an export with require_contact_id=true.
records_without_contact_idRecords that did not resolve to a contact_id.
First date covered by the window (YYYY-MM-DD).
Last date covered by the window (YYYY-MM-DD).
Per-day record counts ordered oldest to newest. Populated only when the request set include_daily_counts=true.
Auto-created paginated export, populated when the request set auto_export. Use the embedded export_id directly with POST /intent/feeds/exports/page — no separate POST /intent/feeds/exports call required.
Preview or create a feed
Preview a query or save it as a feed.
preview=true— returns metrics only (date window, total records, records with contact IDs, and daily counts). Nothing is saved.preview=false— saves the feed and returns itsfeed_id.
lookback_days is capped at 14. Counts against your org's feed
limit when saving.
Preview or create a feed › Request Body
textNatural-language search query.
lookback_daysRolling window in days. Max 14.
Choose how closely results should match your phrase.
Option 1 — Use a preset
"low"— broader matches."medium"— balanced matches (default)."high"— closer matches.
Option 2 — Set a numeric level
Use an integer from 0 to 10. Higher values require a closer match. Send a JSON number, such as 5, not a quoted string or decimal.
Equivalent settings: 3 = low, 5 = medium, 7 = high.
output_typeFeed output mode. consumer is the default; business uses B2B export filters and bundle rules.
Optional name for the feed. Defaults to the query.
previewWhen true, returns metrics only and saves nothing. When false, saves the feed and returns its id.
Preview or create a feed › Responses
Successful Response
Set when the feed was saved.
Set when the feed was saved.
Set when the feed was saved.
Set when the feed was saved.
Set when preview=true.