Saved analyses tools

search_funnels

Searches the saved funnel analyses in a project, or fetches one by ID. Funnels measure step-by-step customer conversion through event sequences. Omit funnel_id to list all funnels — the response gives you the name, tags, archived flag, and initiative assignment. Pass funnel_id to fetch the full definition of a single funnel analysis: the steps (event filters), the date range, the conversion window, and any breakdown attributes.

Request parameters

NameTypeRequired?Description
project_idstrYesThe project ID returned by list_projects.
funnel_idstrNoThe funnel ID. Omit to list all funnels; provide to fetch one.

Response parameters

The tool returns a FunnelsResponse when funnel_id is omitted, or a FunnelResponse when it's provided.

When funnel_id is omitted, the FunnelsResponse object has the following parameters:

ParameterTypeDescription
successboolWhether the request succeeded.
datalist[FunnelSummary]The funnel summaries.
errorstr | nullError message if the request failed.

The FunnelSummary object has the following fields:

FieldTypeDescription
idstrThe funnel's unique ID.
namestrThe funnel's display name.
archivedboolWhether the funnel has been archived.
tagslist[str]User-defined tags.
initiative_idstr | nullThe initiative this funnel belongs to, if any.
createdany | nullUnix timestamp of when the funnel was created.
created_by_display_namestr | nullDisplay name of the creator.
editedany | nullUnix timestamp of the last edit.
edited_by_display_namestr | nullDisplay name of the last editor.

When funnel_id is provided, the FunnelResponse object has the following parameters:

ParameterTypeDescription
successboolWhether the request succeeded.
dataFunnel | nullThe full funnel definition.
errorstr | nullError message if the request failed.

The Funnel object adds the following field on top of the summary record:

FieldTypeDescription
definitionany | nullThe funnel analysis definition: steps (event filters), date range, conversion window, and breakdown attributes.

search_trends

Searches the saved trend analyses in a project, or fetches one by ID. Trend analyses show how a metric changes over time, for example daily event count or weekly revenue. Omit trend_id to list all trends — the response gives you the name, tags, archived flag, and initiative assignment. Pass trend_id to fetch the full definition of a single trend analysis: the metrics, event filters, date range, and time granularity.

Request parameters

NameTypeRequired?Description
project_idstrYesThe project ID returned by list_projects.
trend_idstrNoThe trend ID. Omit to list all trends; provide to fetch one.

Response parameters

The tool returns a TrendsResponse when trend_id is omitted, or a TrendResponse when it's provided.

When trend_id is omitted, the TrendsResponse object has the following parameters:

ParameterTypeDescription
successboolWhether the request succeeded.
datalist[TrendSummary]The trend analysis summaries.
errorstr | nullError message if the request failed.

The TrendSummary object has the following fields:

FieldTypeDescription
idstrThe trend's unique ID.
namestrThe trend's display name.
archivedboolWhether the trend has been archived.
tagslist[str]User-defined tags.
initiative_idstr | nullThe initiative this trend belongs to, if any.
createdany | nullUnix timestamp of when the trend was created.
created_by_display_namestrDisplay name of the creator.
editedany | nullUnix timestamp of the last edit.
edited_by_display_namestrDisplay name of the last editor.

When trend_id is provided, the TrendResponse object has the following parameters:

ParameterTypeDescription
successboolWhether the request succeeded.
dataTrend | nullThe full trend analysis definition.
errorstr | nullError message if the request failed.

The Trend object adds the following field on top of the summary record:

FieldTypeDescription
definitionany | nullThe trend analysis definition: metrics, event filters, date range, and granularity.

search_reports

Searches the saved report analyses in a project, or fetches one by ID. Reports are multi-metric analytics views that combine event data across dimensions. Omit report_id to list all reports — the response gives you the name, tags, archived flag, and initiative assignment. Pass report_id to fetch the full definition of a single report analysis: the metrics, dimensions, filters, and date range. To execute a report and get computed results, use calculate_report.

Request parameters

NameTypeRequired?Description
project_idstrYesThe project ID returned by list_projects.
report_idstrNoThe report ID. Omit to list all reports; provide to fetch one.

Response parameters

The tool returns a ReportsResponse when report_id is omitted, or a ReportResponse when it's provided.

When report_id is omitted, the ReportsResponse object has the following parameters:

ParameterTypeDescription
successboolWhether the request succeeded.
datalist[ReportSummary]The report summaries.
errorstr | nullError message if the request failed.

The ReportSummary object has the following fields:

FieldTypeDescription
idstrThe report's unique ID.
namestrThe report's display name.
archivedboolWhether the report has been archived.
tagslist[str]User-defined tags.
initiative_idstr | nullThe initiative this report belongs to, if any.
createdany | nullUnix timestamp of when the report was created.
created_by_display_namestrDisplay name of the creator.
editedany | nullUnix timestamp of the last edit.
edited_by_display_namestrDisplay name of the last editor.

When report_id is provided, the ReportResponse object has the following parameters:

ParameterTypeDescription
successboolWhether the request succeeded.
dataReport | nullThe full report definition.
errorstr | nullError message if the request failed.

The Report object adds the following field on top of the summary record:

FieldTypeDescription
definitionany | nullThe report definition: metrics, dimensions, filters, and date range.


Did this page help you?

© Bloomreach, Inc. All rights reserved.