HubSpot: Retrieve metrics

← Campaigns operations · Get started

Operation hubspot.campaigns_reports_get_metrics

Provider route: GET /marketing/campaigns/2026-09/{campaignGuid}/reports/metrics. 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["campaigns"]["reportsGetMetrics"]>[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.campaigns.reportsGetMetrics(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.campaigns.reports_get_metrics(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.campaignGuid	string	Required within parent
query	object	Optional	Additional keys: not allowed
query.endDate	string	Optional
query.startDate	string	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 Retrieve metrics — response body

Referenced models: Retrieve metrics — response body

Schemas

Retrieve metrics — response body

Field	Type	Presence	Description and constraints
$	object	Root
influencedContacts	JSON	Required within parent
influencedContacts (anyOf 1)	integer	Alternative	The number of contacts that were influenced by the campaign. This is an integer value. Format: int32
influencedContacts (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
newContactsFirstTouch	JSON	Required within parent
newContactsFirstTouch (anyOf 1)	integer	Alternative	The number of new contacts that had their first interaction with the campaign. This is an integer value. Format: int32
newContactsFirstTouch (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
newContactsLastTouch	JSON	Required within parent
newContactsLastTouch (anyOf 1)	integer	Alternative	The number of new contacts that had their last interaction with the campaign. This is an integer value. Format: int32
newContactsLastTouch (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sessions	JSON	Required within parent
sessions (anyOf 1)	integer	Alternative	The number of sessions associated with the campaign. This is an integer value. Format: int32
sessions (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: hubspot.campaigns_reports_get_metrics. Catalog operation: campaigns_reports_get_metrics. 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: ["marketing.campaigns.read"]

Official provider source