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
| Name | Type | Required? | Description |
|---|---|---|---|
project_id | str | Yes | The project ID returned by list_projects. |
Response parameters
The tool returns a FunnelsResponse object with the following parameters:
| Parameter | Type | Description |
|---|---|---|
success | bool | Whether the request succeeded. |
data | list[FunnelSummary] | The funnel summaries. |
error | str | null | Error message if the request failed. |
The FunnelSummary object has the following fields:
| Field | Type | Description |
|---|---|---|
id | str | The funnel's unique ID. |
name | str | The funnel's display name. |
archived | bool | Whether the funnel has been archived. |
tags | list[str] | User-defined tags. |
initiative_id | str | null | The initiative this funnel belongs to, if any. |
created | any | null | Unix timestamp of when the funnel was created. |
created_by_display_name | str | null | Display name of the creator. |
edited | any | null | Unix timestamp of the last edit. |
edited_by_display_name | str | null | Display 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
| Name | Type | Required? | Description |
|---|---|---|---|
project_id | str | Yes | The project ID returned by list_projects. |
funnel_id | str | Yes | The funnel ID returned by list_funnels. |
Response parameters
The tool returns a FunnelResponse object with the following parameters:
| Parameter | Type | Description |
|---|---|---|
success | bool | Whether the request succeeded. |
data | Funnel | null | The full funnel definition. |
error | str | null | Error message if the request failed. |
The Funnel object adds the following field on top of the summary record:
| Field | Type | Description |
|---|---|---|
definition | any | null | The 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
| Name | Type | Required? | Description |
|---|---|---|---|
project_id | str | Yes | The project ID returned by list_projects. |
Response parameters
The tool returns a TrendsResponse object with the following parameters:
| Parameter | Type | Description |
|---|---|---|
success | bool | Whether the request succeeded. |
data | list[TrendSummary] | The trend analysis summaries. |
error | str | null | Error message if the request failed. |
The TrendSummary object has the following fields:
| Field | Type | Description |
|---|---|---|
id | str | The trend's unique ID. |
name | str | The trend's display name. |
archived | bool | Whether the trend has been archived. |
tags | list[str] | User-defined tags. |
initiative_id | str | null | The initiative this trend belongs to, if any. |
created | any | null | Unix timestamp of when the trend was created. |
created_by_display_name | str | Display name of the creator. |
edited | any | null | Unix timestamp of the last edit. |
edited_by_display_name | str | Display 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
| Name | Type | Required? | Description |
|---|---|---|---|
project_id | str | Yes | The project ID returned by list_projects. |
trend_id | str | Yes | The trend ID returned by list_trends. |
Response parameters
The tool returns a TrendResponse object with the following parameters:
| Parameter | Type | Description |
|---|---|---|
success | bool | Whether the request succeeded. |
data | Trend | null | The full trend analysis definition. |
error | str | null | Error message if the request failed. |
The Trend object adds the following field on top of the summary record:
| Field | Type | Description |
|---|---|---|
definition | any | null | The 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
| Name | Type | Required? | Description |
|---|---|---|---|
project_id | str | Yes | The project ID returned by list_projects. |
Response parameters
The tool returns a ReportsResponse object with the following parameters:
| Parameter | Type | Description |
|---|---|---|
success | bool | Whether the request succeeded. |
data | list[ReportSummary] | The report summaries. |
error | str | null | Error message if the request failed. |
The ReportSummary object has the following fields:
| Field | Type | Description |
|---|---|---|
id | str | The report's unique ID. |
name | str | The report's display name. |
archived | bool | Whether the report has been archived. |
tags | list[str] | User-defined tags. |
initiative_id | str | null | The initiative this report belongs to, if any. |
created | any | null | Unix timestamp of when the report was created. |
created_by_display_name | str | Display name of the creator. |
edited | any | null | Unix timestamp of the last edit. |
edited_by_display_name | str | Display 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
| Name | Type | Required? | Description |
|---|---|---|---|
project_id | str | Yes | The project ID returned by list_projects. |
report_id | str | Yes | The report ID returned by list_reports. |
Response parameters
The tool returns a ReportResponse object with the following parameters:
| Parameter | Type | Description |
|---|---|---|
success | bool | Whether the request succeeded. |
data | Report | null | The full report definition. |
error | str | null | Error message if the request failed. |
The Report object adds the following field on top of the summary record:
| Field | Type | Description |
|---|---|---|
definition | any | null | The report definition: metrics, dimensions, filters, and date range. |
Updated about 1 hour ago
