get_campaign_recipient_estimation
Retrieve estimated recipient counts for a Klaviyo campaign to plan email sends and manage audience targeting.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ID of the campaign to retrieve recipient estimations for |
Implementation Reference
- src/tools/campaigns.js:106-118 (handler)The handler function for the get_campaign_recipient_estimation tool. It fetches the recipient estimation for a given campaign ID from the Klaviyo API and returns the JSON response, or an error message if the request fails.async (params) => { try { const estimation = await klaviyoClient.get(`/campaign-recipient-estimations/${params.id}/`); return { content: [{ type: "text", text: JSON.stringify(estimation, null, 2) }] }; } catch (error) { return { content: [{ type: "text", text: `Error retrieving campaign recipient estimation: ${error.message}` }], isError: true }; } },
- src/tools/campaigns.js:103-105 (schema)Zod schema defining the input parameter 'id' for the get_campaign_recipient_estimation tool.{ id: z.string().describe("ID of the campaign to retrieve recipient estimations for") },
- src/tools/campaigns.js:101-120 (registration)Registration of the get_campaign_recipient_estimation tool within the registerCampaignTools function, including schema, handler, and description.server.tool( "get_campaign_recipient_estimation", { id: z.string().describe("ID of the campaign to retrieve recipient estimations for") }, async (params) => { try { const estimation = await klaviyoClient.get(`/campaign-recipient-estimations/${params.id}/`); return { content: [{ type: "text", text: JSON.stringify(estimation, null, 2) }] }; } catch (error) { return { content: [{ type: "text", text: `Error retrieving campaign recipient estimation: ${error.message}` }], isError: true }; } }, { description: "Get estimated recipient count for a campaign" } );