get_top_events
Retrieve the most common events from Mixpanel to identify key user actions, prioritize feature development, and understand platform usage patterns.
Instructions
Get a list of the most common events over the last 31 days. Useful for identifying key user actions, prioritizing feature development, and understanding overall platform usage patterns.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | No | The Mixpanel project ID. Optional since it has a default. | |
| type | No | The type of events to fetch, either general, average, or unique, defaults to general | |
| limit | No | Maximum number of events to return |
Implementation Reference
- src/index.ts:708-759 (handler)The handler function that implements the core logic of the get_top_events tool. It authenticates with Mixpanel using service account credentials, constructs the API URL for /events/names endpoint with parameters project_id, type, and limit, fetches the data, and returns the JSON response or error.async function handleGetTopEvents(args: any, config: any) { const { project_id = config.DEFAULT_PROJECT_ID, type = "general", limit = 10 } = args; try { // Create authorization header using base64 encoding of credentials const credentials = `${config.SERVICE_ACCOUNT_USER_NAME}:${config.SERVICE_ACCOUNT_PASSWORD}`; const encodedCredentials = Buffer.from(credentials).toString('base64'); // Construct URL with query parameters const url = `${config.MIXPANEL_BASE_URL}/events/names?project_id=${project_id}&type=${type}${limit ? `&limit=${limit}` : ''}`; // Set up request options const options = { method: 'GET', headers: { 'accept': 'application/json', 'authorization': `Basic ${encodedCredentials}` } }; // Make the API request const response = await fetch(url, options); if (!response.ok) { const errorText = await response.text(); throw new Error(`HTTP error! status: ${response.status} - ${errorText}`); } const data = await response.json(); return { content: [ { type: "text", text: JSON.stringify(data) } ] }; } catch (error: unknown) { console.error("Error fetching Mixpanel events:", error); const errorMessage = error instanceof Error ? error.message : String(error); return { content: [ { type: "text", text: `Error fetching Mixpanel events: ${errorMessage}` } ], isError: true }; } }
- src/index.ts:609-610 (registration)The switch case in the CallToolRequestSchema handler that dispatches calls to the get_top_events tool to its handler function.case "get_top_events": return await handleGetTopEvents(args, { SERVICE_ACCOUNT_USER_NAME, SERVICE_ACCOUNT_PASSWORD, DEFAULT_PROJECT_ID, MIXPANEL_BASE_URL });
- src/index.ts:257-278 (registration)The tool registration object returned by ListToolsRequestSchema handler, defining the name, description, and input schema for get_top_events.{ name: "get_top_events", description: "Get a list of the most common events over the last 31 days. Useful for identifying key user actions, prioritizing feature development, and understanding overall platform usage patterns.", inputSchema: { type: "object", properties: { project_id: { type: "string", description: "The Mixpanel project ID. Optional since it has a default." }, type: { type: "string", enum: ["general", "average", "unique"], description: "The type of events to fetch, either general, average, or unique, defaults to general" }, limit: { type: "number", description: "Maximum number of events to return" } } } },
- src/index.ts:260-277 (schema)The input schema definition for the get_top_events tool, specifying properties for project_id (string, optional), type (string enum, optional), and limit (number, optional). Used for client-side validation and documentation.inputSchema: { type: "object", properties: { project_id: { type: "string", description: "The Mixpanel project ID. Optional since it has a default." }, type: { type: "string", enum: ["general", "average", "unique"], description: "The type of events to fetch, either general, average, or unique, defaults to general" }, limit: { type: "number", description: "Maximum number of events to return" } } }