HubSpot: Get aggregated statistics

← Marketing emails operations · Get started

Operation hubspot.marketing_emails_get_statistics

Provider route: GET /marketing/emails/2026-09/statistics/list. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["marketingEmails"]["getStatistics"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.marketingEmails.getStatistics(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.marketing_emails.get_statistics(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.emailIds	array	Optional
query.emailIds[]	integer	Each item	Format: int64
query.endTimestamp	string	Optional	Format: date-time
query.property	string	Optional
query.startTimestamp	string	Optional	Format: date-time

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get aggregated statistics — response body

Referenced models: Get aggregated statistics — response body

Schemas

Get aggregated statistics — response body

Field	Type	Presence	Description and constraints
$	object	Root
aggregate	Model	Required within parent	Expand Create Email — response body — stats
campaignAggregations	object	Required within parent	The aggregated statistics per campaign. Additional keys: see wildcard field
campaignAggregations.*	Model	Additional keys	Expand Create Email — response body — stats
emails	array	Required within parent	List of email IDs that were sent during the time span.
emails[]	JSON	Each item
emails[] (anyOf 1)	integer	Alternative	Format: int64
emails[] (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Create Email — response body — stats

Create Email — response body — stats

Field	Type	Presence	Description and constraints
$	object	Root
counters	object	Required within parent	Counters like number of `sent`, `open` or `delivered`. Additional keys: see wildcard field
counters.*	JSON	Additional keys
counters.* (anyOf 1)	integer	Alternative	Format: int64
counters.* (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
deviceBreakdown	object	Required within parent	Statistics by device. Additional keys: see wildcard field
deviceBreakdown.*	object	Additional keys	Additional keys: see wildcard field
deviceBreakdown.*.*	JSON	Additional keys
deviceBreakdown.*.* (anyOf 1)	integer	Alternative	Format: int64
deviceBreakdown.*.* (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
qualifierStats	object	Required within parent	Number of emails that were dropped and bounced. Additional keys: see wildcard field
qualifierStats.*	object	Additional keys	Additional keys: see wildcard field
qualifierStats.*.*	JSON	Additional keys
qualifierStats.*.* (anyOf 1)	integer	Alternative	Format: int64
qualifierStats.*.* (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ratios	object	Required within parent	Ratios like `openratio` or `clickratio` Additional keys: see wildcard field
ratios.*	JSON	Additional keys
ratios.* (anyOf 1)	number	Alternative
ratios.* (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: hubspot.marketing_emails_get_statistics. Catalog operation: marketing_emails_get_statistics. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["content"]

Official provider source