Get campaign analytics with the Instantly API

Returns, per campaign, the leads, contacted, emails sent, opens, replies, link clicks, bounces, unsubscribes, completed leads and opportunities, for one campaign or all of them.

Identifier
instantly_get_campaign_analytics

The request

POST https://connect.reportei.com/api/tools/instantly_get_campaign_analytics/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "id": "<id>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
idstringNoId of the campaign, from List campaigns. Omit it for every campaign.
start_datestringNoStart of the period, as a date like 2026-10-01 (UTC midnight) or a full ISO 8601 timestamp.
end_datestringNoEnd of the period, in the same formats as start_date.
exclude_total_leads_countbooleanNoWhen true, leaves out the total of leads, which makes the call much faster.

Supported connections

Your customer connects their Instantly account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/instantly_get_campaign_analytics. It becomes your agent's tool definition with no conversion.

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.