get_report_results
Fetch advertising campaign report results from Kayzen Analytics by providing a report ID and optional date range to analyze performance data.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | No | End date in YYYY-MM-DD format | |
| report_id | Yes | ID of the report to fetch results for | |
| start_date | No | Start date in YYYY-MM-DD format |
Implementation Reference
- src/server.ts:57-89 (registration)Full registration of the MCP tool 'get_report_results', including input schema with Zod validation and the handler function that delegates to KayzenClient and returns formatted results or error.server.tool( "get_report_results", { report_id: z.string().describe("ID of the report to fetch results for"), start_date: z.string().optional().describe("Start date in YYYY-MM-DD format"), end_date: z.string().optional().describe("End date in YYYY-MM-DD format") }, async (params: { report_id: string; start_date?: string; end_date?: string }) => { try { const result = await kayzenClient.getReportResults( params.report_id, params.start_date, params.end_date ) as ReportResultsResponse; return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] }; } catch (error) { const errorMessage = error instanceof Error ? error.message : String(error); return { content: [{ type: "text", text: `Error getting report results: ${errorMessage}` }], isError: true }; } } );
- src/server.ts:64-88 (handler)The core handler logic for the 'get_report_results' tool: invokes KayzenClient.getReportResults with parameters and returns JSON-formatted response or error message.async (params: { report_id: string; start_date?: string; end_date?: string }) => { try { const result = await kayzenClient.getReportResults( params.report_id, params.start_date, params.end_date ) as ReportResultsResponse; return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] }; } catch (error) { const errorMessage = error instanceof Error ? error.message : String(error); return { content: [{ type: "text", text: `Error getting report results: ${errorMessage}` }], isError: true }; } }
- src/server.ts:59-63 (schema)Zod-based input schema defining parameters for the tool: report_id (required string), start_date and end_date (optional strings).{ report_id: z.string().describe("ID of the report to fetch results for"), start_date: z.string().optional().describe("Start date in YYYY-MM-DD format"), end_date: z.string().optional().describe("End date in YYYY-MM-DD format") },
- src/kayzen-client.ts:94-100 (helper)KayzenClient helper method that makes the actual API request to fetch report results using makeRequest, constructing query params for date filters.async getReportResults(reportId: string, startDate?: string, endDate?: string) { const params: Record<string, string> = {}; if (startDate) params.start_date = startDate; if (endDate) params.end_date = endDate; return this.makeRequest('GET', `/reports/${reportId}/report_results`, params); }