Saved analyses tools

  • list_funnels: List the saved funnel analyses in a project.
  • get_funnel: Get the full definition of a funnel analysis.
  • list_trends: List the saved trend analyses in a project.
  • get_trend: Get the full definition of a trend analysis.
  • list_reports: List the saved report analyses in a project.
  • get_report: Get the full definition of a report analysis.

list_funnels

Lists every saved funnel analysis in a project. Funnels measure step-by-step customer conversion through event sequences. The response gives you the name, tags, archived flag, and initiative assignment. The funnel definition (steps, date range, conversion window) is not included here — use get_funnel for that.

Request parameters

NameTypeRequired?Description
project_idstrYesThe project ID returned by list_projects.

Response parameters

The tool returns a FunnelsResponse object with 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.

get_funnel

Returns 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_idstrYesThe funnel ID returned by list_funnels.

Response parameters

The tool returns a FunnelResponse object with 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.

list_trends

Lists every saved trend analysis in a project. Trend analyses show how a metric changes over time, for example daily event count or weekly revenue. The response gives you the name, tags, archived flag, and initiative assignment. The trend definition is not included here — use get_trend for that.

Request parameters

NameTypeRequired?Description
project_idstrYesThe project ID returned by list_projects.

Response parameters

The tool returns a TrendsResponse object with 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.

get_trend

Returns 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_idstrYesThe trend ID returned by list_trends.

Response parameters

The tool returns a TrendResponse object with 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.

list_reports

Lists every saved report analysis in a project. Reports are multi-metric analytics views that combine event data across dimensions. The response gives you the name, tags, archived flag, and initiative assignment. The report definition is not included here — use get_report for that.

Request parameters

NameTypeRequired?Description
project_idstrYesThe project ID returned by list_projects.

Response parameters

The tool returns a ReportsResponse object with 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.

get_report

Returns the full definition of a single report analysis: the metrics, dimensions, filters, and date range.

Request parameters

NameTypeRequired?Description
project_idstrYesThe project ID returned by list_projects.
report_idstrYesThe report ID returned by list_reports.

Response parameters

The tool returns a ReportResponse object with 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.


© Bloomreach, Inc. All rights reserved.