Skip to main content
SegmentStream MCP provides 51 tools organized into functional categories. Your AI assistant automatically discovers and uses these tools based on your prompts — you do not need to call them explicitly. Tools work best when combined. For example, to get a campaign performance report, the assistant will first call list_active_projects to find your project, then list_conversions and list_attribution_models to resolve the right IDs, and finally run_report to fetch the data.
All tools are read-only. SegmentStream MCP cannot modify your project configuration.

AI agent orchestration

Internal tools that help AI agents plan and validate their work. These are called automatically by the assistant — you do not need to use them directly.
Always called at the start of each user turn, before using other SegmentStream tools. Pass the user’s message verbatim. Returns project context, relevant configuration, and an analytical approach tailored to the request. If status is clarify, the assistant resolves the ambiguity and calls again. If status is proceed, the assistant follows the returned approach.Parameters:
NameTypeRequiredDescription
user_promptstringYesThe user’s question or request, verbatim
project_idstringNoOmit to auto-resolve
Returns: Project context, configuration details, and a step-by-step analytical approach.
Always called after completing work, before responding to the user. Pass the full draft response. Returns a quality assessment. If status is approved, the assistant presents the response incorporating any suggestions. If status is revise, the assistant makes corrections and calls again with an updated draft.Parameters:
NameTypeRequiredDescription
response_draftstringYesThe full response planned for the user
Returns: Quality assessment with status (approved or revise) and suggestions.

Projects and account

Tools for listing projects and checking your account.
List all active SegmentStream projects with their id, name, timezone, type, account, and BigQuery configuration (bigqueryProjectId, bigqueryDatasetId). Super users also see serviceAccountEmail.Parameters: NoneReturns: Array of project objects with ID, name, timezone, type, account info, and BigQuery settings.Example prompts:
  • “List all my SegmentStream projects”
  • “Which projects do I have access to?”
  • “What is the BigQuery dataset ID for my project?”
Get project details: name, timezone, currency, type, features, state, attributionAdjustment, maxAttributionWindow, workflowState, and billingAccount.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
Returns: Full project configuration object.Example prompts:
  • “Show me the details of project X”
  • “What timezone and currency is this project configured with?”
  • “What features are enabled for this project?”
Get the authenticated user’s profile: id, name, email, and role.Parameters: NoneReturns: User profile object with id, name, email, and role.Example prompts:
  • “Who am I logged in as?”
  • “What role do I have?”

Data sources

Tools for inspecting connected advertising platforms and their import status.
List all data sources for a SegmentStream project.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
Returns: Array of data source objects.Example prompts:
  • “What ad platforms are connected to this project?”
  • “Show me all data sources”
  • “Which data sources are enabled?”
Get a single data source with details: id, name, type, isEnabled, isAuthenticated, options, authMeta, and workflow status.Parameters:
NameTypeRequiredDescription
data_source_idstringYesThe data source ID
Returns: Full data source configuration object.Example prompts:
  • “Show me the configuration of the Facebook data source”
  • “Is the Google Ads data source authenticated?”
Get import logs for a data source: phase, startedAt, fillDate, status, errors, and message.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
data_source_idstringYesThe data source ID
Returns: Array of import log entries with phase, timestamps, status, and error details.Example prompts:
  • “Show me the recent import logs for our Facebook data source”
  • “Are there any import errors for Google Ads?”
  • “When was the last successful import for this data source?”

Data streams

Tools for inspecting event data streams (GA4 BigQuery exports, SDK streams, etc.).
List all data streams for a project: id, type, timezone, isEnabled, isConnected, displayName, destinationTableName, and config.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
Returns: Array of data stream objects.Example prompts:
  • “What data streams are configured?”
  • “Show me all connected event tracking sources”
  • “Is the GA4 BigQuery stream connected?”
Get a single data stream with details: id, type, timezone, isEnabled, isConnected, displayName, destinationTableName, and config.Parameters:
NameTypeRequiredDescription
data_stream_idstringYesThe data stream ID
Returns: Full data stream configuration object.Example prompts:
  • “Show me the configuration of this data stream”
  • “What table does this stream write to?”
Test connectivity to a data stream. Returns a status code (non-zero indicates success).Parameters:
NameTypeRequiredDescription
data_stream_idstringYesThe data stream ID
Returns: Status code (non-zero indicates success).Example prompts:
  • “Test the connection for our GA4 data stream”
  • “Is the data stream still connected?”

Conversions

Tools for inspecting conversion definitions, statistics, and geographic breakdowns.
List all conversions for a project with their id, name, type, modelledConversionId, isUniqueConversion, hidden, and legacy fields.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
Returns: Array of conversion objects.Example prompts:
  • “What conversions are configured in this project?”
  • “List all active conversions”
  • “Show me the conversion IDs I need for reporting”
Get a single conversion with full configuration including events, audiences, deduplication settings, attribution settings, data sources, and combined conversions.Parameters:
NameTypeRequiredDescription
conversion_idstringYesThe conversion ID
Returns: Full conversion configuration object.Example prompts:
  • “Show me how the Purchase conversion is configured”
  • “What events trigger this conversion?”
  • “What deduplication settings does this conversion use?”
Get conversion statistics including totalConversions, totalSessions, totalValues, visitors, conversionsHistory (per date), and exportsHistory.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
conversion_idstringYesThe conversion ID
date_fromstringNoStart date in YYYY-MM-DD format
date_tostringNoEnd date in YYYY-MM-DD format
chart_granularitystringNoDAY or HOUR
Returns: Statistics object with totals and per-date history.Example prompts:
  • “How many purchases happened last month?”
  • “Show me the daily conversion trend for the past 30 days”
  • “What is the total conversion value this quarter?”
Get conversions grouped by country for a given conversion and date range.Parameters:
NameTypeRequiredDescription
conversion_idstringYesThe conversion ID
project_idstringYesThe project ID
start_datestringYesStart date in YYYY-MM-DD format
end_datestringYesEnd date in YYYY-MM-DD format
Returns: Conversions grouped by country.Example prompts:
  • “Which countries had the most purchases last month?”
  • “Break down lead conversions by country for Q4”

Attribution models

Tools for inspecting attribution model configurations.
List all attribution models for a project with their id, name, algorithm, attributionWindow, adjustment, filter, dimension, isDefault, and isDisabled.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
Returns: Array of attribution model objects.Example prompts:
  • “What attribution models are available?”
  • “Which attribution model is the default?”
  • “Show me all attribution model IDs”
Get a single attribution model with full details including calibration, dimension values, and self-reported attribution settings.Parameters:
NameTypeRequiredDescription
idstringYesThe attribution model ID
project_idstringYesThe project ID
Returns: Full attribution model configuration object.Example prompts:
  • “Show me the configuration of the Multi-Touch attribution model”
  • “What is the attribution window for the Last Click model?”
  • “Does this model use self-reported attribution?”

Reports and analytics

Tools for querying campaign performance data — the primary way to pull metrics from SegmentStream.
Run a report query: campaign performance dimensions, metrics (attribution and conversion), and row-level data. This is the primary tool for querying campaign performance — it supports date ranges, dimension grouping, attribution models, filters, and sorting. Use format: "csv" for a compact representation that uses fewer tokens.Supports 30+ built-in dimensions (campaign_name, ad_platform, country, source_medium, date, etc.) plus custom dimensions. Metrics are passed as a single unified list — the server automatically determines whether each metric is a traffic metric or a conversion metric.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
formatstringNoResponse format: json (default) or csv. Use csv for a compact tabular representation
params.date_rangeobjectYesPrimary date range with from and to in YYYY-MM-DD
params.comparison_date_rangeobjectNoComparison date range for period-over-period analysis
params.dimensionsarrayNoDimensions to group by (e.g., campaign_name, ad_platform, channel). channel is a built-in alias for the Channel custom dimension. Use list_custom_dimensions to discover other custom dimensions
params.metricsarrayNoMetrics to return. Traffic: clicks, cost, impressions, sessions, users, cpc, cpm, ctr, avg_session_duration, time_on_site, video_views, video_view_rate. Conversion: conversions, conversion_value, converted_users, conversion_rate, cpa, roas, aov, and _by_conv_time / _incl_projected variants. Server infers metric type automatically
params.attributed_conversionsarrayNoArray of {id, conversion_id, attribution_id} objects — required when conversion metrics are requested
params.filterobjectNoFilter expression with dimension, operator, and values — supports and/or combinators. Binary operators: equals, not_equals, contains, not_contains, in, not_in, gt, gte, lt, lte. Unary operators: is_set, not_set
params.order_byarrayNoSort order. Each item has metric, direction (asc/desc), optional attributed_conversion_id and scope
params.limitnumberNoMax rows (default 1000, max 1000)
params.offsetnumberNoRow offset for pagination
params.time_machine_datestringNoTime machine date (YYYY-MM-DD) — sets both ML score date and max conversion date
params.calculated_metricsobjectNoCalculated metrics definition with custom expression trees
Returns: Table data with dimensions and metrics for each row, plus totals.Example prompts:
  • “Show me the top 10 campaigns by cost for the last 30 days”
  • “What is the ROAS by ad platform for last month?”
  • “Give me a breakdown of conversions by source/medium and country”
  • “Compare campaign performance between this month and last month”
Run a timeseries report: per-date attribution metrics, conversion metrics, and calculated metrics over a date range. Useful for visualizing trends over time and spotting anomalies.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
params.date_rangeobjectYesDate range with from and to in YYYY-MM-DD
params.granularitystringNoday (default), hour, week, or month
params.metricsarrayNoMetrics to return (same as run_report)
params.attributed_conversionsarrayNoConversion + attribution model pairs. Required when conversion metrics are requested
params.filterobjectNoFilter expression
params.time_machine_datestringNoTime machine date (YYYY-MM-DD)
params.calculated_metricsobjectNoCalculated metrics definition
Returns: Per-date data points for the requested metrics.Example prompts:
  • “Show me the daily cost trend for the past 30 days”
  • “Plot weekly conversions over the last 3 months”
  • “Chart the ROAS trend by week for Facebook campaigns”
Run a saved report config by ID. Loads the config settings (dimensions, metrics, filters, ordering) and executes the query. Optionally override the date range, filter, or sort order. Use list_report_configs to find config IDs.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
config_idstringYesThe saved report config ID (from list_report_configs)
date_rangeobjectNoOverride the saved date range. If omitted, uses the config’s firstDateRange
filterobjectNoOverride the saved filter. If omitted, uses the config’s filter (if any)
order_byarrayNoOverride the saved sort order. If omitted, uses the config’s ordering
formatstringNoResponse format: json (default) or csv
limitnumberNoMax rows (default 1000, max 1000)
offsetnumberNoRow offset for pagination
Returns: Table data with dimensions and metrics, using the saved config settings plus any overrides.Example prompts:
  • “Run the Performance Overview report for last month”
  • “Execute the saved channel report but filter by Google Ads only”
  • “Run report config X with a custom date range”
List all report configurations for a project. Returns id, name, and order for each report. Use get_report_config to fetch full settings for a specific report.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
Returns: Array of report configuration summaries.Example prompts:
  • “What reports are saved in this project?”
  • “List all report configurations”
Get a single report configuration with full settings: date ranges, dimensions, attribution/conversion metrics, filters, ordering, and chart config.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
report_idstringYesThe report config ID
Returns: Full report configuration object.Example prompts:
  • “Show me the configuration of the Performance Overview report”
  • “What dimensions and metrics does this report use?”
Get available values for a report dimension (used to populate filter dropdowns). Provide one of: common_dimension for built-in dimensions (e.g., campaign_name, ad_platform, channel), custom_dimension_key for custom dimension group names, or custom_field with an optional custom_field_scope. The channel dimension is a built-in alias for the Channel custom dimension. Use prefix to narrow the results.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
common_dimensionstringNoBuilt-in dimension name. One of: account_id, account_name, ad_group_id, ad_group_name, ad_id, ad_name, ad_platform, anonymous_id, campaign_id, campaign_name, campaign_type, channel, city, country, data_source_id, date, device, device_brand, domain, landing_page, landing_page_path, region, source_medium, targeting_id, targeting_name, user_id, utm_campaign, utm_content, utm_medium, utm_source, utm_term
custom_dimension_keystringNoCustom dimension key — returns group names for that dimension
custom_fieldstringNoCustom field name (e.g., event.name)
custom_field_scopestringNoCustom field scope (table name)
prefixstringNoPrefix to filter returned values
Returns: Array of available values for the specified dimension.Example prompts:
  • “What campaign names are available for filtering?”
  • “List all ad platform values in this project”
  • “What values are available for the source_medium dimension?”
Enqueue a CSV export for a report. Returns a job ID that can be polled with get_download_job (type: csv-v4) to obtain the download URL once the export is ready.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
paramsobjectYesSame parameters as run_report
report_namestringNoHuman-readable report name for the CSV file
billing_account_namestringNoBilling account name to include in the CSV
intervalstringNoDate interval shorthand: custom, last_7_days, last_14_days, last_28_days, last_30_days, last_60_days, last_90_days, last_6_months, last_12_months, yesterday
Returns: Job ID for polling with get_download_job.Example prompts:
  • “Export this report as a CSV”
  • “Download campaign performance data for the last quarter”
Poll the status of a download job (CSV or Google Sheets export). Returns progress (0—100), status, download URL (when completed), and failure reason (when failed).Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
job_idstringYesJob ID returned by export_report_csv
typestringYesJob type: csv-v4 or google-sheets-v4
Returns: Job status object with progress (0—100), status (waiting, active, completed, failed), download URL, and failedReason.Example prompts:
  • “Is my CSV export ready?”
  • “Check the status of the download job”
Preview the generated BigQuery SQL for a report query without executing it. Returns the SQL query string and resolved attributed conversions JSON. Useful for debugging report queries.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
paramsobjectYesSame parameters as run_report
Returns: Object with sqlQueryString and attributed conversions JSON.Example prompts:
  • “Show me the SQL that would be generated for this report”
  • “What BigQuery query does SegmentStream run for campaign performance?”

User journey

Tools for tracing individual user paths and attribution credit distribution.
Query the user journey for a date range, returning all sessions with attribution credits, conversions, audience memberships, and user keys. Filter by anonymous_id or user_id. Useful for debugging attribution and understanding individual user paths.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
params.date_fromstringYesStart date (YYYY-MM-DD)
params.date_tostringYesEnd date (YYYY-MM-DD)
params.attributed_conversionsarrayYesArray of {id, conversion_id, attribution_id} objects
params.conversion_internal_idsarrayYesConversion internal IDs to include
params.selected_anonymous_idstringNoFilter to a specific anonymous ID
params.selected_user_idstringNoFilter to a specific user ID
Returns: Sessions with attribution credits, conversions, audience memberships, and user keys.Example prompts:
  • “Show me the user journey for anonymous ID abc123 over the last 30 days”
  • “What touchpoints led to the last conversion for user [email protected]?”
  • “Trace the journey for this anonymous ID and show attribution credits”
Get the generated BigQuery SQL and query parameters for a user journey query without executing it. Useful for debugging attribution SQL.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
paramsobjectYesSame parameters as get_user_journey
Returns: BigQuery SQL string and query parameters.Example prompts:
  • “Show me the SQL behind this user journey query”
  • “Debug the user journey query for this anonymous ID”

BigQuery

Direct SQL access to your project’s BigQuery dataset.
Execute a read-only BigQuery SQL query. The project’s BigQuery dataset is set as the default, so you can reference tables without fully qualifying them (e.g., hitsSet instead of project.dataset.hitsSet). Use list_active_projects to find the bigqueryProjectId and bigqueryDatasetId for each project.Parameters:
NameTypeRequiredDescription
project_idstringYesThe SegmentStream project ID (use list_active_projects to find it)
querystringYesThe BigQuery SQL query to execute. Tables can be referenced without full qualification since the default dataset is set automatically
Returns: Query results as JSON.Example prompts:
  • “Run a query to count sessions by country for last week”
  • “Show me the schema of the sessions table”
  • “Query the raw events table for the last 24 hours”
  • “How many unique users visited the site yesterday?”
Get the schema (column names, types, modes) of a BigQuery table via the API — no SQL needed. Use this before writing SQL queries to verify table structure and available columns. Returns null if the table does not exist. Use list_active_projects to find the project ID.Parameters:
NameTypeRequiredDescription
project_idstringYesThe SegmentStream project ID
table_namestringYesThe table name within the project dataset (e.g., hitsSet, sessions). Do not fully qualify — the project dataset is used automatically
Returns: Array of column objects with name, type, and mode.Example prompts:
  • “What columns does the sessions table have?”
  • “Show me the schema for hitsSet”
  • “What fields are available in the stitched_sessions table?”

Custom dimensions

Tools for inspecting custom dimensions configured in your project.
List all custom dimensions for a project with their key, name, and type.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
Returns: Array of custom dimension objects with key, name, and type.Example prompts:
  • “What custom dimensions are available?”
  • “List all custom dimension keys I can use in reports”
Get a single custom dimension with full details including SQL expression and dimension groups.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
keystringYesThe custom dimension key
Returns: Full custom dimension object with SQL expression and groups.Example prompts:
  • “Show me the SQL expression for the brand/non-brand custom dimension”
  • “How is this custom dimension calculated?”

Self-reported attribution

Tools for inspecting self-reported attribution (SRA) settings.
Get self-reported attribution settings for a project, including the three-stage pipeline fields: extractionSql, classifierEnabled, channelMappings, overrideConditions, and isMigrated.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
Returns: SRA configuration object with extraction SQL, classifier settings, channel mappings, override conditions, and migration status.Example prompts:
  • “Show me the self-reported attribution settings”
  • “What channel mappings are configured for SRA?”
  • “Is the SRA classifier enabled?”

Audiences

Tools for inspecting audience definitions and memberships.
List audiences for a project, optionally filtered by ML model or conversion. Returns id, name, isForever, filter, membershipDurationDays, and status for each audience.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
ml_model_idstringNoFilter audiences by ML model
conversion_idstringNoFilter audiences by conversion
Returns: Array of audience objects.Example prompts:
  • “What audiences are defined in this project?”
  • “List all audiences associated with the Purchase conversion”
Get a single audience with full details including id, name, projectId, isForever, filter, filterSql, membershipDurationDays, status, createdAt, and updatedAt.Parameters:
NameTypeRequiredDescription
audience_idstringYesThe audience ID
Returns: Full audience configuration object.Example prompts:
  • “Show me the filter criteria for this audience”
  • “How long do users stay in this audience?”
Query audience memberships for a specific client (anonymous ID) within a date range. Returns audienceId, audienceName, entryTime, and expirationTime for each membership.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
anonymous_idstringYesThe anonymous client ID to query audience memberships for
fromstringYesStart date (ISO date, e.g., 2025-01-01)
tostringYesEnd date (ISO date, e.g., 2025-01-31)
Returns: Array of audience membership objects with entry and expiration times.Example prompts:
  • “What audiences does anonymous ID abc123 belong to?”
  • “Show me audience memberships for this user over the last 30 days”
Get audience inclusion statistics for a project: per-audience inclusion count and percent, total inclusion, total percent, and allUsers count. Optionally filter by ML model.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
ml_model_idstringNoFilter inclusion stats by ML model
Returns: Inclusion statistics with per-audience counts and percentages.Example prompts:
  • “What percentage of users are in each audience?”
  • “Show me audience inclusion statistics”

Workflows

Tools for monitoring data processing workflows.
List recent workflows for a SegmentStream project.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
limitnumberNoMaximum number of workflows to return (default 20)
Returns: Array of workflow objects.Example prompts:
  • “Show me the recent workflows”
  • “What data processing jobs ran today?”
Get the status and details of a specific workflow, including data source logs and errors.Parameters:
NameTypeRequiredDescription
workflow_idstringYesThe workflow ID
Returns: Workflow status object with data source logs and error details.Example prompts:
  • “What is the status of this workflow?”
  • “Did this workflow complete successfully?”
  • “Show me any errors from the last workflow run”

Cost data quality

Tools for monitoring advertising cost data accuracy.
Get cost data quality metrics: quality scores (total, 7-day, 1-day) and histogram. Optionally filter by data source and date range.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
data_source_idnumberNoScope results to a specific data source
date_fromstringNoStart date (YYYY-MM-DD)
date_tostringNoEnd date (YYYY-MM-DD)
Returns: Quality scores and histogram data.Example prompts:
  • “What is the cost data quality score for this project?”
  • “Show me the data quality for the Facebook data source”
  • “How has cost data quality changed over the last 30 days?”

Identity graph

Tools for inspecting user identity stitching.
Get identity graph statistics including user stitching distribution, key combinations, and data completeness.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
conversion_internal_idstringNoFilter by internal conversion ID
days_backnumberNoNumber of days to look back
use_users_v2booleanNoWhether to use the users v2 engine
Returns: Identity graph statistics object.Example prompts:
  • “Show me the identity graph statistics”
  • “How many users have cross-device stitching?”
  • “What is the user stitching distribution for the last 30 days?”

Incidents

Tools for checking project health alerts.
List incidents for a project with optional filtering by status and pagination.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
statusstringNoFilter by status: Ok or Error
limitnumberNoMaximum number of incidents to return
offsetnumberNoNumber of incidents to skip for pagination
minimum_updated_atstringNoOnly return incidents updated after this ISO-8601 date
Returns: Array of incident objects.Example prompts:
  • “Are there any active incidents?”
  • “Show me recent errors for this project”
  • “List all incidents from the last week”

Classifiers (ML models)

Tools for inspecting ML-based classifiers used for conversion scoring.
List all classifiers for a project with their configuration.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
Returns: Array of classifier objects.Example prompts:
  • “What ML classifiers are configured?”
  • “Show me the classifier settings for this project”
Get a single classifier with full configuration.Parameters:
NameTypeRequiredDescription
classifier_idstringYesThe classifier ID
Returns: Full classifier configuration object.Example prompts:
  • “Show me the details of this classifier”
  • “What model does this classifier use?”
List available classifier models with pricing information.Parameters: NoneReturns: Array of available classifier model types with pricing.Example prompts:
  • “What classifier models are available?”
  • “Show me the pricing for classifier models”

Portfolios (budget optimization)

Tools for inspecting portfolio configurations, performance history, and optimization scenarios.
List all portfolios for a project with their id, name, goal, granularity, hidden status, metrics (potentialMetric, actualMetric, actualSpend), targetsCount, isReady, and lastApplyTime.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
Returns: Array of portfolio objects with configuration and summary metrics.Example prompts:
  • “What portfolios are configured in this project?”
  • “List all optimization portfolios”
  • “Which portfolios are ready for optimization?”
Get portfolio performance history. When called with only portfolio_id (and optional period), returns a summary with per-period rows and plots. When start_date and end_date are provided, returns detailed period data including per-campaign breakdowns.Parameters:
NameTypeRequiredDescription
portfolio_idstringYesThe portfolio ID
periodstringNoHistory period: LAST_MONTH, LAST_THREE_MONTHS (default), or LAST_SIX_MONTHS
start_datestringNoPeriod start date (ISO-8601, e.g., 2025-01-01). When provided with end_date, returns detailed per-campaign breakdowns
end_datestringNoPeriod end date (ISO-8601, e.g., 2025-01-31). When provided with start_date, returns detailed per-campaign breakdowns
Returns: Performance history with per-period metrics and optional per-campaign detail.Example prompts:
  • “Show me the portfolio performance over the last 3 months”
  • “What was the campaign-level breakdown for January?”
  • “How has this portfolio performed over the last 6 months?”
Get portfolio optimization data from the Optimize tab: current scenario, per-target optimization results with marginal metrics, diminishing return curves, and optional maturation/projection data.Parameters:
NameTypeRequiredDescription
portfolio_idstringYesThe portfolio ID
total_budget_limitnumberNoTotal budget constraint for the optimization period
total_daily_budget_limitnumberNoDaily budget constraint for optimization
optimization_versionstringNoOptimization algorithm version (default: v7)
Returns: Optimization scenario with per-target results, marginal metrics, and diminishing return curves.Example prompts:
  • “Show me the optimization recommendations for this portfolio”
  • “What would the optimal budget allocation look like with a $50,000 monthly budget?”
  • “Show me the diminishing returns curves for portfolio targets”

Experiments (geo tests)

Tools for inspecting geo-lift experiments.
List all experiments for a project with their status, preparation, and analysis results.Parameters:
NameTypeRequiredDescription
project_idstringYesThe project ID
Returns: Array of experiment objects with status and results.Example prompts:
  • “What experiments are running?”
  • “Show me all geo tests and their status”
  • “List completed experiments with their results”
Get a single experiment with full details including plots, preparation, and analysis results.Parameters:
NameTypeRequiredDescription
experiment_idstringYesThe experiment ID
Returns: Full experiment object with plots, preparation data, and analysis results.Example prompts:
  • “Show me the results of this geo test”
  • “What was the measured lift in this experiment?”
  • “Show me the experiment preparation details”
Get available custom parameter keys for market-split experiments.Parameters:
NameTypeRequiredDescription
conversion_idstringYesThe conversion ID
Returns: Array of custom parameter keys.Example prompts:
  • “What custom parameters can I use for geo test segmentation?”
  • “List available custom parameter keys for experiments”