HubSpot: Get aggregated statistic intervals

← Marketing emails operations · Get started

Operation hubspot.marketing_emails_statistics_get_histogram

Provider route: GET /marketing/emails/2026-09/statistics/histogram. 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"]["statisticsGetHistogram"]>[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.statisticsGetHistogram(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.statistics_get_histogram(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.interval	string	Optional	One of: DAY, HOUR, MINUTE, MONTH, QUARTER, QUARTER_HOUR, SECOND, WEEK, YEAR
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 statistic intervals — response body

Referenced models: Get aggregated statistic intervals — response body

Schemas

Get aggregated statistic intervals — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand List Emails — response body — paging
results	array	Required within parent	An array of EmailStatisticInterval objects, each representing statistics for a specific time interval.
results[]	Model	Each item	Expand Get aggregated statistic intervals — response body — results item
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	An integer representing the total number of email statistic intervals available. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List Emails — response body — paging, Get aggregated statistic intervals — response body — results item

List Emails — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
next	Model	Optional	Expand List Emails — response body — paging next
prev	Model	Optional	Expand List Emails — response body — paging prev

Referenced models: List Emails — response body — paging next, List Emails — response body — paging prev

Get aggregated statistic intervals — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
aggregations	Model	Required within parent	Expand Create Email — response body — stats
interval	Model	Required within parent	Expand Get aggregated statistic intervals — response body — results item interval

Referenced models: Get aggregated statistic intervals — response body — results item interval, Create Email — response body — stats

List Emails — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	The cursor token value to get the next set of results. Use this value as query parameter (&after=...) to obtain the next page.
link	string	Optional	The link to the next page.

List Emails — response body — paging prev

Field	Type	Presence	Description and constraints
$	object	Root	specifies the paging information needed to retrieve the previous set of results in a paginated API response
before	string	Required within parent	The cursor token value to get the previous set of results. Use this value as query parameter (&before=...) to obtain the previous page.
link	string	Optional	The link to the previous page.

Get aggregated statistic intervals — response body — results item interval

Field	Type	Presence	Description and constraints
$	object	Root
end	string	Required within parent	The end timestamp of the interval, in ISO8601 format. Format: date-time
start	string	Required within parent	The start timestamp of the interval, in ISO8601 format. Format: date-time

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_statistics_get_histogram. Catalog operation: marketing_emails_statistics_get_histogram. 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