get_event_series
Retrieve website event metrics over time series data by specifying time range, grouping unit, and optional filters for URL or event name.
Instructions
Get event metrics over time (event series data) for a website
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| websiteId | Yes | Website UUID | |
| startAt | Yes | Start timestamp in milliseconds | |
| endAt | Yes | End timestamp in milliseconds | |
| unit | Yes | Time grouping unit | |
| timezone | No | Timezone (e.g. 'Asia/Seoul') | |
| url | No | Filter by URL path | |
| eventName | No | Filter by event name |
Implementation Reference
- src/tools/stats.ts:165-175 (handler)Handler implementation for get_event_series tool.
async ({ websiteId, startAt, endAt, unit, timezone, url, eventName }) => { const data = await client.call("GET", `/api/websites/${websiteId}/events/series`, undefined, { startAt, endAt, unit, timezone, url, eventName, }); return { content: [{ type: "text", text: JSON.stringify(data, null, 2) }] }; } - src/tools/stats.ts:157-164 (schema)Schema/input validation for get_event_series tool.
{ websiteId: z.string().describe("Website UUID"), ...dateRange, unit: z.enum(["hour", "day", "week", "month", "year"]).describe("Time grouping unit"), timezone: z.string().optional().describe("Timezone (e.g. 'Asia/Seoul')"), url: z.string().optional().describe("Filter by URL path"), eventName: z.string().optional().describe("Filter by event name"), }, - src/tools/stats.ts:154-176 (registration)Registration of get_event_series tool.
server.tool( "get_event_series", "Get event metrics over time (event series data) for a website", { websiteId: z.string().describe("Website UUID"), ...dateRange, unit: z.enum(["hour", "day", "week", "month", "year"]).describe("Time grouping unit"), timezone: z.string().optional().describe("Timezone (e.g. 'Asia/Seoul')"), url: z.string().optional().describe("Filter by URL path"), eventName: z.string().optional().describe("Filter by event name"), }, async ({ websiteId, startAt, endAt, unit, timezone, url, eventName }) => { const data = await client.call("GET", `/api/websites/${websiteId}/events/series`, undefined, { startAt, endAt, unit, timezone, url, eventName, }); return { content: [{ type: "text", text: JSON.stringify(data, null, 2) }] }; } );