This tool is for analyzing Stripe Sigma and Metrics data (e.g. about revenue, charges, products, invoices, subscriptions, disputes, transactions, tax tables, payments etc) and run…
View input schema
{
"type": "object",
"properties": {
"intent": {
"description": "The intent of the tool call.",
"type": "string",
"enum": [
"stripe_data_search",
"execute_query_run",
"retrieve_query_run",
"retrieve_query_table",
"execute_query_template",
"retrieve_query_template",
"retrieve_report_type",
"create_report_run",
"retrieve_report_run"
]
},
"params": {
"type": "object",
"description": "The parameters for the tool call. Required parameters depend on the intent.",
"properties": {
"search_string": {
"description": "Used with stripe_data_search. Keywords to match against the names and descriptions of the available metrics, tables, templates, and reports.",
"type": "string"
},
"sql": {
"description": "Used with execute_query_run. The SQL query to execute (Trino 414).",
"type": "string"
},
"query_run_id": {
"description": "Used with retrieve_query_run, or retrieve_query_template for a QueryRun an earlier template run returned. The QueryRun ID to retrieve.",
"type": "string",
"pattern": "^(qryrun|qrun)_[a-zA-Z0-9_]+$"
},
"table_name": {
"description": "Used with retrieve_query_table. The table name.",
"type": "string",
"pattern": "^[a-zA-Z0-9_]+$"
},
"metric": {
"description": "Used with execute_query_template. The canonical metric name.",
"type": "string",
"enum": [
"gross_volume",
"subscriber_churn_rate",
"gross_mrr_churn_rate",
"churned_subscribers",
"net_mrr_churn_rate",
"churned_revenue",
"new_subscribers",
"active_subscribers",
"active_subscriber_growth",
"mrr_growth_rate",
"arr",
"net_volume",
"new_trials",
"active_trials",
"converted_trials"
]
},
"dimensions": {
"description": "Used with execute_query_template. One dimension to group by, 'product' or 'price'. Only active_subscribers supports it.",
"type": "array",
"minItems": 1,
"maxItems": 1,
"items": {
"type": "string",
"enum": [
"product",
"price"
]
}
},
"grains": {
"description": "Used with execute_query_template. One time grain, 'day' or 'month'. Default is 'month'. No weekly report exists: for weekly results, use 'day' and aggregate by week.",
"type": "array",
"minItems": 1,
"maxItems": 1,
"items": {
"type": "string",
"enum": [
"day",
"month"
]
}
},
"report_id": {
"description": "Used with retrieve_report_type and create_report_run. The unique identifier of the `Report` object (format report_*).",
"type": "string"
},
"report_run_id": {
"description": "Used with retrieve_report_run or retrieve_query_template. The unique identifier of the `Report Run` object (format reprun_* or rrun_*, depending on which API created it).",
"type": "string"
},
"report_parameters": {
"description": "Used with create_report_run. A map of parameter names to values for `Report Run` customization.",
"type": "object",
"additionalProperties": true
},
"result_options": {
"description": "Used with execute_query_run or create_report_run. Optional settings for the generated results.",
"type": "object",
"properties": {
"compression": {
"type": "string",
"enum": [
"none",
"zip"
],
"description": "Compression applied to the generated results file. Defaults to none."
}
}
},
"include": {
"description": "Used with retrieve_query_run or retrieve_report_run. Results are inline under result.inline by default; pass [\"result.file\"] to get a downloadable file link instead.",
"type": "array",
"items": {
"type": "string",
"enum": [
"result.inline",
"result.file"
]
},
"maxItems": 1
},
"page": {
"description": "With retrieve_query_run or retrieve_report_run, pass the result.inline.next_page_url value from a previous response to fetch the next page of inline result rows.",
"type": "string"
},
"limit": {
"description": "Used with retrieve_query_run or retrieve_report_run. Maximum number of inline result rows to return. Defaults to 100, maximum 1000.",
"type": "integer",
"minimum": 1,
"maximum": 1000
}
}
}
},
"required": [
"intent"
]
}