get_campaign_recipient_estimation
Retrieve estimated recipient counts for Klaviyo campaigns by specifying the campaign ID. This tool simplifies audience size assessment for effective campaign planning.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ID of the campaign to retrieve recipient estimations for |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "ID of the campaign to retrieve recipient estimations for",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}
Implementation Reference
- src/tools/campaigns.js:106-117 (handler)Handler function that retrieves the campaign recipient estimation by calling the Klaviyo API endpoint `/campaign-recipient-estimations/{id}/` and returns the JSON response or an error message.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 input schema defining the required 'id' parameter as a string.{ id: z.string().describe("ID of the campaign to retrieve recipient estimations for") },
- src/tools/campaigns.js:101-120 (registration)Tool registration using server.tool(), specifying name, input schema, handler function, 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" } );