Cakemail icon

Cakemail

Interact with Cakemail API

Report → Get Campaign Stats

AI-generated

Summary

Retrieve statistics for a specific campaign.

Inputs

  • accountId — Optional: Specify an account ID for multi-tenant operations. If not provided, uses the authenticated account.
  • campaignId (required) — The ID of the campaign.
  • reportAdditionalFields — Additional fields to filter statistics such as start date, end date, pagination options, etc.

Output shape

a detailed report of statistics related to the specified campaign

Returns a comprehensive set of statistics for the campaign, including opens, clicks, and other relevant metrics. The data can be filtered by provided date ranges, and paginated results can be specified. Use 'start_date' and 'end_date' for filtering.

Examples

Example 1: Retrieve campaign stats for a specific campaign

Inputs include 'campaignId' set to 12345 and optional 'reportAdditionalFields' containing pagination settings.

Discussion