> ## Documentation Index
> Fetch the complete documentation index at: https://br.developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve participant breakdown by external ID

> Leia o detalhamento das participações do evento de marketing pelo par externalAccountId e externalEventId.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/legacy/v3/marketing-marketing-events-v3.json GET /marketing/v3/marketing-events/participations/{externalAccountId}/{externalEventId}/breakdown
openapi: 3.0.1
info:
  title: Marketing Marketing Events
  description: Basepom for all HubSpot Projects
  version: v3
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
  x-hubspot-related-documentation:
    - name: Marketing Events Guide
      url: >-
        https://developers.hubspot.com/docs/guides/api/marketing/marketing-events
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Basic
  - name: Batch
  - name: Event Attendees
  - name: Event Status
  - name: Identifiers
  - name: List Associations
  - name: Participant State
  - name: Settings
  - name: Subscriber State Changes
paths:
  /marketing/v3/marketing-events/participations/{externalAccountId}/{externalEventId}/breakdown:
    get:
      tags:
        - Participant State
      summary: >-
        Ler detalhamento das participações pelo identificador externo do evento
        de marketing
      description: >-
        Leia o detalhamento das participações do evento de marketing pelo par
        externalAccountId e externalEventId.
      operationId: >-
        get-/marketing/v3/marketing-events/participations/{externalAccountId}/{externalEventId}/breakdown_getParticipationsBreakdownByExternalEventId
      parameters:
        - name: externalAccountId
          in: path
          description: >-
            O accountId que está associado a este evento de marketing no
            aplicativo de eventos externos.
          required: true
          style: simple
          explode: false
          schema:
            type: string
        - name: externalEventId
          in: path
          description: O ID do evento de marketing no aplicativo de eventos externos.
          required: true
          style: simple
          explode: false
          schema:
            type: string
        - name: after
          in: query
          description: O cursor que indica a posição do último item recuperado.
          required: false
          style: form
          explode: true
          schema:
            type: string
        - name: contactIdentifier
          in: query
          description: O identificador do contato. Pode ser o e-mail ou ID interno.
          required: false
          style: form
          explode: true
          schema:
            type: string
        - name: limit
          in: query
          description: >-
            O limite para o tamanho da resposta. O valor padrão é 10; o número
            máximo é 100.
          required: false
          style: form
          explode: true
          schema:
            type: integer
            format: int32
            default: 10
        - name: state
          in: query
          description: >-
            O valor do estado da participação. Pode ser REGISTERED, CANCELLED,
            ATTENDED, NO_SHOW
          required: false
          style: form
          explode: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/CollectionResponseWithTotalParticipationBreakdown
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - crm.objects.marketing_events.read
components:
  schemas:
    CollectionResponseWithTotalParticipationBreakdown:
      required:
        - results
        - total
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/Paging'
        results:
          type: array
          items:
            $ref: '#/components/schemas/ParticipationBreakdown'
        total:
          type: integer
          format: int32
    Paging:
      type: object
      properties:
        next:
          $ref: '#/components/schemas/NextPage'
        prev:
          $ref: '#/components/schemas/PreviousPage'
      description: >-
        Representa as informações de paginação para navegar por uma lista de
        resultados na API. Ele fornece detalhes sobre como acessar o conjunto
        anterior ou seguinte de resultados.
    ParticipationBreakdown:
      required:
        - associations
        - createdAt
        - id
        - properties
      type: object
      properties:
        associations:
          $ref: '#/components/schemas/ParticipationAssociations'
        createdAt:
          type: string
          description: A data e hora de criação do evento de marketing de destino
          format: date-time
        id:
          type: string
          description: O ID interno do evento de marketing de destino
        properties:
          $ref: '#/components/schemas/ParticipationProperties'
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: A categoria de erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Um identificador exclusivo para a solicitação. Inclua este valor em
            relatórios de erro ou tickets de suporte
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: mais informações sobre o erro
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um mapa de nomes de links para URIs associados que contêm
            documentação sobre o erro ou as etapas de correção recomendadas
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa uma resposta de erro retornada pela API quando uma operação
        falha. Este componente é usado em vários endpoints para fornecer
        informações detalhadas sobre o erro encontrado.
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    NextPage:
      required:
        - after
      type: object
      properties:
        after:
          type: string
          description: O elemento ID no início da página
        link:
          type: string
          description: Link para a próxima página
      description: >-
        Especifica as informações de paginação necessárias para recuperar o
        próximo conjunto de resultados em uma resposta de API paginada
    PreviousPage:
      required:
        - before
      type: object
      properties:
        before:
          type: string
          description: A paging cursor token for retrieving previous pages.
        link:
          type: string
          description: A URL that can be used to retrieve the previous pages' results.
      description: >-
        specifies the paging information needed to retrieve the previous set of
        results in a paginated API response
    ParticipationAssociations:
      required:
        - contact
        - marketingEvent
      type: object
      properties:
        contact:
          $ref: '#/components/schemas/ContactAssociation'
        marketingEvent:
          $ref: '#/components/schemas/MarketingEventAssociation'
    ParticipationProperties:
      required:
        - attendanceState
        - occurredAt
      type: object
      properties:
        attendanceDurationSeconds:
          type: integer
          description: O número de segundos que durou a participação
          format: int32
        attendancePercentage:
          type: string
          description: >-
            Percentagem da duração da participação em relação à duração do
            evento
        attendanceState:
          type: string
          description: O estado da participação
          enum:
            - ATTENDED
            - CANCELLED
            - EMPTY
            - NO_SHOW
            - REGISTERED
        occurredAt:
          type: integer
          description: A data e a hora em que a participação ocorreu
          format: int64
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: O código de status associado ao detalhe do erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: O nome do campo ou parâmetro no qual o erro foi encontrado.
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa informações detalhadas sobre um erro ocorrido na API. Este
        componente é usado para fornecer contexto e detalhes adicionais sobre os
        erros, geralmente como parte de uma resposta de erro.
    ContactAssociation:
      required:
        - contactId
        - email
      type: object
      properties:
        contactId:
          type: string
          description: O ID interno do contato no HubSpot
        email:
          type: string
          description: O e-mail do contato no HubSpot
        firstname:
          type: string
          description: O nome do contato no HubSpot
        lastname:
          type: string
          description: O sobrenome do contato no HubSpot
    MarketingEventAssociation:
      required:
        - marketingEventId
        - name
      type: object
      properties:
        externalAccountId:
          type: string
          description: >-
            O ID da conta associada a este evento de marketing no aplicativo de
            eventos externo
        externalEventId:
          type: string
          description: >-
            O ID do evento associado a este evento de marketing no aplicativo de
            eventos externo
        marketingEventId:
          type: string
          description: O ID interno do evento de marketing no HubSpot
        name:
          type: string
          description: O nome do evento de marketing no HubSpot
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            crm.objects.marketing_events.read: ''
            crm.objects.marketing_events.write: ''

````