GET
/
marketing
/
v3
/
marketing-events
/
participations
/
{externalAccountId}
/
{externalEventId}
/
breakdown
Read participations breakdown by Marketing Event external identifier
curl --request GET \
  --url https://api.hubapi.com/marketing/v3/marketing-events/participations/{externalAccountId}/{externalEventId}/breakdown \
  --header 'Authorization: Bearer <token>'
{
  "total": 123,
  "paging": {
    "next": {
      "link": "",
      "after": ""
    }
  },
  "results": [
    {
      "associations": {
        "marketingEvent": {
          "externalAccountId": "<string>",
          "marketingEventId": "<string>",
          "externalEventId": "<string>",
          "name": "<string>"
        },
        "contact": {
          "firstname": "<string>",
          "contactId": "<string>",
          "email": "<string>",
          "lastname": "<string>"
        }
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "properties": {
        "occurredAt": 123,
        "attendancePercentage": "<string>",
        "attendanceState": "REGISTERED",
        "attendanceDurationSeconds": 123
      }
    }
  ]
}
Supported products
Requires one of the following products or higher.
Marketing HubMarketing HubFree
Sales HubSales HubFree
Service HubService HubFree
Content HubContent HubStarter

​
Required Scopes

This API requires one of the following scopes:
  • crm.objects.marketing_events.read

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
externalAccountId
string
required

The accountId that is associated with this marketing event in the external event application.

​
externalEventId
string
required

The id of the marketing event in the external event application.

Query Parameters

​
contactIdentifier
string

The identifier of the Contact. It may be email or internal id.

​
state
string

The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW

​
limit
integer
default:10

The limit for response size. The default value is 10, the max number is 100

​
after
string

The cursor indicating the position of the last retrieved item.

Response

200
application/json

successful operation

The response is of type object.