Get Email Statistics by Subuser
get_subuser_statsRetrieve email performance statistics for SendGrid subusers within specified date ranges to analyze engagement metrics and campaign effectiveness.
Instructions
Retrieve email statistics for specific subusers
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| subusers | Yes | Comma-separated list of subuser names to retrieve stats for | |
| start_date | Yes | Start date in YYYY-MM-DD format | |
| end_date | No | End date in YYYY-MM-DD format (defaults to today) | |
| aggregated_by | No | How to group the statistics | day |
Implementation Reference
- src/tools/stats.ts:170-177 (handler)The handler function that fetches email statistics for specified subusers from the SendGrid API.
handler: async ({ subusers, start_date, end_date, aggregated_by }: { subusers: string; start_date: string; end_date?: string; aggregated_by?: string }): Promise<ToolResult> => { let url = `https://api.sendgrid.com/v3/subusers/stats?subusers=${encodeURIComponent(subusers)}&start_date=${start_date}`; if (end_date) url += `&end_date=${end_date}`; if (aggregated_by) url += `&aggregated_by=${aggregated_by}`; const result = await makeRequest(url); return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] }; }, - src/tools/stats.ts:163-168 (schema)Zod schema for validating the input parameters of the get_subuser_stats tool.
inputSchema: { subusers: z.string().describe("Comma-separated list of subuser names to retrieve stats for"), start_date: z.string().describe("Start date in YYYY-MM-DD format"), end_date: z.string().optional().describe("End date in YYYY-MM-DD format (defaults to today)"), aggregated_by: z.enum(["day", "week", "month"]).optional().default("day").describe("How to group the statistics"), }, - src/tools/stats.ts:159-177 (registration)The complete tool definition for get_subuser_stats, including config, schema, and handler, within the exported statsTools object.
get_subuser_stats: { config: { title: "Get Email Statistics by Subuser", description: "Retrieve email statistics for specific subusers", inputSchema: { subusers: z.string().describe("Comma-separated list of subuser names to retrieve stats for"), start_date: z.string().describe("Start date in YYYY-MM-DD format"), end_date: z.string().optional().describe("End date in YYYY-MM-DD format (defaults to today)"), aggregated_by: z.enum(["day", "week", "month"]).optional().default("day").describe("How to group the statistics"), }, }, handler: async ({ subusers, start_date, end_date, aggregated_by }: { subusers: string; start_date: string; end_date?: string; aggregated_by?: string }): Promise<ToolResult> => { let url = `https://api.sendgrid.com/v3/subusers/stats?subusers=${encodeURIComponent(subusers)}&start_date=${start_date}`; if (end_date) url += `&end_date=${end_date}`; if (aggregated_by) url += `&aggregated_by=${aggregated_by}`; const result = await makeRequest(url); return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] }; }, - src/tools/index.ts:6-17 (registration)Registration of statsTools (which includes get_subuser_stats) into the aggregate allTools export.
import { statsTools } from "./stats.js"; import { templateTools } from "./templates.js"; export const allTools = { ...automationTools, ...campaignTools, ...contactTools, ...mailTools, ...miscTools, ...statsTools, ...templateTools, };