HubSpot: Read participations breakdown by Marketing Event internal identifier

← Marketing events operations · Get started

Operation hubspot.marketing_events_list_participation_breakdown

Provider route: GET /marketing/marketing-events/2026-09/participations/{marketingEventId}/breakdown. 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["marketingEvents"]["listParticipationBreakdown"]>[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.marketingEvents.listParticipationBreakdown(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_events.list_participation_breakdown(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.marketingEventId	integer	Required within parent	Format: int64
query	object	Optional	Additional keys: not allowed
query.after	string	Optional
query.contactIdentifier	string	Optional
query.limit	integer	Optional	Default: 10 Format: int32
query.state	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 Read participations breakdown by Contact identifier — response body

Referenced models: Read participations breakdown by Contact identifier — response body

Schemas

Read participations breakdown by Contact identifier — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand Find Marketing Events by External Event Id — response body — paging
results	array	Required within parent	An array of participation breakdown objects, each detailing a specific participation instance.
results[]	Model	Each item	Expand Read participations breakdown by Contact identifier — response body — results item
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	An integer representing the total number of participation breakdowns available. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Find Marketing Events by External Event Id — response body — paging, Read participations breakdown by Contact identifier — response body — results item

Find Marketing Events by External Event Id — 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 — marketing Events get Marketing Events — response body — paging next
prev	Model	Optional	Expand Find Marketing Events by External Event Id — response body — paging prev

Referenced models: List — marketing Events get Marketing Events — response body — paging next, Find Marketing Events by External Event Id — response body — paging prev

Read participations breakdown by Contact identifier — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
associations	Model	Required within parent	Expand Read participations breakdown by Contact identifier — response body — results item associations
createdAt	string	Required within parent	The creation time and date of the target marketing event Format: date-time
id	string	Required within parent	The internal ID of the target marketing event
properties	Model	Required within parent	Expand Read participations breakdown by Contact identifier — response body — results item properties

Referenced models: Read participations breakdown by Contact identifier — response body — results item associations, Read participations breakdown by Contact identifier — response body — results item properties

List — marketing Events get Marketing Events — 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 ID element at the start of the page
link	string	Optional	Link to the next page

Find Marketing Events by External Event Id — 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	A string that serves as a cursor indicating the position before the first item in the current set of results, used to fetch the previous set of results.
link	string	Optional	A string containing the URL link to the previous page of results.

Read participations breakdown by Contact identifier — response body — results item associations

Field	Type	Presence	Description and constraints
$	object	Root
contact	Model	Required within parent	Expand Read participations breakdown by Contact identifier — response body — results item associations contact
marketingEvent	Model	Required within parent	Expand Read participations breakdown by Contact identifier — response body — results item associations marketing Event

Referenced models: Read participations breakdown by Contact identifier — response body — results item associations contact, Read participations breakdown by Contact identifier — response body — results item associations marketing Event

Read participations breakdown by Contact identifier — response body — results item properties

Field	Type	Presence	Description and constraints
$	object	Root
attendanceDurationSeconds	JSON	Optional
attendanceDurationSeconds (anyOf 1)	integer	Alternative	The number of seconds the participation lasted Format: int32
attendanceDurationSeconds (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
attendancePercentage	string	Optional	Percentage of the participation duration relative to the event duration
attendanceState	string	Required within parent	The state of the participation Known values: ATTENDED, CANCELLED, EMPTY, NO_SHOW, REGISTERED
occurredAt	JSON	Required within parent
occurredAt (anyOf 1)	integer	Alternative	Timestamp of when the participation occurred Format: int64
occurredAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Read participations breakdown by Contact identifier — response body — results item associations contact

Field	Type	Presence	Description and constraints
$	object	Root
contactId	string	Required within parent	The internal ID of the contact in HubSpot
email	string	Required within parent	The email of the contact in HubSpot
firstname	string	Optional	The first name of the contact in HubSpot
lastname	string	Optional	The last name of the contact in HubSpot

Read participations breakdown by Contact identifier — response body — results item associations marketing Event

Field	Type	Presence	Description and constraints
$	object	Root
externalAccountId	string	Optional	The account ID that is associated with this marketing event in the external event application
externalEventId	string	Optional	The event ID that is associated with this marketing event in the external event application
marketingEventId	string	Required within parent	The internal ID of the marketing event in HubSpot
name	string	Required within parent	The name of the marketing event in HubSpot

Policy, approvals and errors

SDK function policy ID: hubspot.marketing_events_list_participation_breakdown. Catalog operation: marketing_events_list_participation_breakdown. 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: ["crm.objects.marketing_events.read"]

Official provider source