get_event_data_events
Retrieve custom event analytics data for a website by specifying time range and optional event name filtering to track user interactions and behavior patterns.
Instructions
Get event data events (custom event names and counts) 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 | |
| eventName | No | Filter by event name |
Implementation Reference
- src/tools/events.ts:61-79 (handler)The tool "get_event_data_events" is defined and implemented within the registerEventTools function in src/tools/events.ts. It calls the client with a GET request to the Umami API.
server.tool( "get_event_data_events", "Get event data events (custom event names and counts) for a website", { websiteId: z.string().describe("Website UUID"), startAt: z.number().describe("Start timestamp in milliseconds"), endAt: z.number().describe("End timestamp in milliseconds"), eventName: z.string().optional().describe("Filter by event name"), }, async ({ websiteId, startAt, endAt, eventName }) => { const data = await client.call( "GET", `/api/websites/${websiteId}/event-data/events`, undefined, { startAt, endAt, eventName } ); return { content: [{ type: "text", text: JSON.stringify(data, null, 2) }] }; } );