HubSpot: Get the variation of a an A B marketing email

← Marketing emails operations · Get started

Operation hubspot.marketing_emails_emails_get_ab_variation

Provider route: GET /marketing/emails/2026-09/{emailId}/ab-test/get-variation. 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"]["emailsGetAbVariation"]>[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.emailsGetAbVariation(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.emails_get_ab_variation(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.emailId	string	Required within parent
query	object	Optional	Additional keys: not allowed
query.archived	boolean	Optional
query.includedProperties	array	Optional
query.includedProperties[]	string	Each item
query.includeStats	boolean	Optional
query.marketingCampaignNames	boolean	Optional
query.variantStats	boolean	Optional
query.workflowNames	boolean	Optional

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 Create Email — response body

Referenced models: Create Email — response body

Schemas

6 more schemas are linked from the tables above, on the schema pages.

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]+)?$

Create Email — response body — content

Field	Type	Presence	Description and constraints
$	object	Root
flexAreas	object	Optional	An object containing flexible area configurations, where each key is an area identifier and the value is an object with area properties. Additional keys: see wildcard field
flexAreas.*	object	Additional keys
plainTextVersion	string	Optional	A string containing the plain text version of the email content.
smartFields	object	Optional	An object containing smart field configurations, where each key is a field identifier and the value is a SmartEmailField object. Additional keys: see wildcard field
smartFields.*	Model	Additional keys	Expand List tags — response body
styleSettings	Model	Optional	Expand Create Email — response body — content style Settings
templatePath	string	Optional	A string representing the path to the email template used for this email.
themeSettingsValues	object	Optional	An object containing theme settings values, where each key is a setting identifier and the value is an object with setting properties. Additional keys: see wildcard field
themeSettingsValues.*	object	Additional keys
widgetContainers	object	Optional	An object containing widget container configurations, where each key is a container identifier and the value is an object with container properties. Additional keys: see wildcard field
widgetContainers.*	object	Additional keys
widgets	object	Optional	An object containing widget configurations, where each key is a widget identifier and the value is an object with widget properties. Additional keys: see wildcard field
widgets.*	object	Additional keys

Referenced models: List tags — response body, Create Email — response body — content style Settings

Create Email — response body — from

Field	Type	Presence	Description and constraints
$	object	Root
customReplyTo	string	Optional	The reply to recipients will see.
fromName	string	Optional	The name recipients will see.
replyTo	string	Optional	The from address and reply to email address (if no customReplyTo defined) recipients will see.

Create Email — response body — subscription Details

Field	Type	Presence	Description and constraints
$	object	Root
officeLocationId	string	Optional	ID of the selected office location.
preferencesGroupId	string	Optional	The identifier for the preferences group associated with the subscription. It is a string value.
subscriptionId	string	Optional	ID of the subscription.
subscriptionName	string	Optional	The name of the email subscription. It is a string value.

Create Email — response body — testing

Field	Type	Presence	Description and constraints
$	object	Root
abSampleSizeDefault	string	Optional	Version of the email that should be sent if there are too few recipients to conduct an AB test. Known values: automated_loser_variant, automated_master, automated_variant, loser_variant, mab_master, mab_variant, master, variant
abSamplingDefault	string	Optional	Version of the email that should be sent if the results are inconclusive after the test period, master or variant. Known values: automated_loser_variant, automated_master, automated_variant, loser_variant, mab_master, mab_variant, master, variant
abStatus	string	Optional	Status of the AB test. Known values: automated_loser_variant, automated_master, automated_variant, loser_variant, mab_master, mab_variant, master, variant
abSuccessMetric	string	Optional	Metric to determine the version that will be sent to the remaining contacts. Known values: CLICKS_BY_DELIVERED, CLICKS_BY_OPENS, OPENS_BY_DELIVERED
abTestPercentage	JSON	Optional
abTestPercentage (anyOf 1)	integer	Alternative	The size of your test group. Format: int32
abTestPercentage (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hoursToWait	JSON	Optional
hoursToWait (anyOf 1)	integer	Alternative	Time limit on gathering test results. After this time is up, the winning version will be sent to the remaining contacts. Format: int32
hoursToWait (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
isAbVariation	boolean	Required within parent	A boolean indicating whether the email is an A/B test variation.
testId	string	Optional	The ID of the AB test.

Create Email — response body — to

Field	Type	Presence	Description and constraints
$	object	Root
contactIds	Model	Optional	Expand Create Email — response body — to contact Ids
contactIlsLists	Model	Optional	Expand Create Email — response body — to contact Ids
contactLists	Model	Optional	Expand Create Email — response body — to contact Ids
limitSendFrequency	boolean	Optional	A boolean indicating whether the frequency of sending emails to the recipients should be limited.
suppressGraymail	boolean	Optional	Whether to send to unengaged contacts (false) or not (true).

Referenced models: Create Email — response body — to contact Ids

Create Email — response body — rss Data

Field	Type	Presence	Description and constraints
$	object	Root
blogEmailType	string	Optional	A string representing the type of blog email.
blogImageMaxWidth	JSON	Optional
blogImageMaxWidth (anyOf 1)	integer	Alternative	The maximum width for images in the blog, specified as an integer. Format: int32
blogImageMaxWidth (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
blogLayout	string	Optional	The layout of the blog in the email. Valid values include 'SUMMARY_NO_FEATURED_IMAGE', 'SUMMARY_WITH_FEATURED_IMAGE', and 'FULL_POST'. Known values: FULL_POST, SUMMARY_NO_FEATURED_IMAGE, SUMMARY_WITH_FEATURED_IMAGE
hubspotBlogId	string	Optional	The unique identifier of the HubSpot blog associated with the RSS email. It is a string.
maxEntries	JSON	Optional
maxEntries (anyOf 1)	integer	Alternative	The maximum number of entries to include from the RSS feed. It is an integer value. Format: int32
maxEntries (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rssEntryTemplate	string	Optional	A string representing the template used for each RSS entry in the email.
timing	object	Optional	An object representing the timing configuration for the RSS email. The specific properties of this object are not detailed in the specification. Additional keys: see wildcard field
timing.*	object	Additional keys
url	string	Optional	The URL of the RSS feed to be used in the email. It is a string.
useHeadlineAsSubject	boolean	Optional	A boolean indicating whether to use the headline of the RSS entry as the subject of the email.

List tags — response body

Field	Type	Presence	Description and constraints
$	object	Root

Create Email — response body — to contact Ids

Field	Type	Presence	Description and constraints
$	object	Root
exclude	array	Optional	Excluded IDs.
exclude[]	string	Each item
include	array	Optional	Included IDs.
include[]	string	Each item

Policy, approvals and errors

SDK function policy ID: hubspot.marketing_emails_emails_get_ab_variation. Catalog operation: marketing_emails_emails_get_ab_variation. 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