> ## 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 event occurrences > **Supported products** > **Required Scopes** ## OpenAPI ````yaml specs/legacy/v3/events-events-v3.json GET /events/v3/events openapi: 3.0.1 info: title: Events Events description: Basepom for all HubSpot Projects version: v3 x-hubspot-product-tier-requirements: marketing: ENTERPRISE sales: ENTERPRISE service: ENTERPRISE cms: ENTERPRISE commerce: ENTERPRISE crmHub: ENTERPRISE dataHub: ENTERPRISE x-hubspot-related-documentation: - name: Web Analytics Guide url: >- https://developers.hubspot.com/docs/guides/api/analytics-and-events/event-analytics servers: - url: https://api.hubapi.com security: [] tags: - name: Basic paths: /events/v3/events: get: tags: - Basic operationId: get-/events/v3/events_/events/v3/events parameters: - name: after in: query description: >- O token do cursor de paginação do último recurso lido com sucesso será retornado como a propriedade JSON "paging.next.after" de uma resposta paginada que contém mais resultados. required: false style: form explode: true schema: type: string - name: before in: query description: '' required: false style: form explode: true schema: type: string - name: eventType in: query description: '' required: false style: form explode: true schema: type: string - name: id in: query description: '' required: false style: form explode: true schema: type: array items: type: string - name: limit in: query description: O número máximo de resultados a serem exibidos por página. required: false style: form explode: true schema: type: integer format: int32 - name: objectId in: query description: '' required: false style: form explode: true schema: type: integer format: int64 - name: objectProperty.{propname} in: query description: '' required: false style: form explode: true schema: type: object - name: objectType in: query description: '' required: false style: form explode: true schema: type: string - name: occurredAfter in: query description: '' required: false style: form explode: true schema: type: string format: date-time - name: occurredBefore in: query description: '' required: false style: form explode: true schema: type: string format: date-time - name: properties in: query description: '' required: false style: form explode: true schema: type: array items: type: string - name: property.{propname} in: query description: '' required: false style: form explode: true schema: type: object - name: sort in: query description: '' required: false style: form explode: true schema: type: array items: type: string responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/CollectionResponseExternalUnifiedEvent' default: $ref: '#/components/responses/Error' description: '' security: [] components: schemas: CollectionResponseExternalUnifiedEvent: required: - results type: object properties: paging: $ref: '#/components/schemas/Paging' results: type: array description: >- Uma matriz de objetos ExternalUnifiedEvent, cada um representando um evento individual com seus detalhes associados. items: $ref: '#/components/schemas/ExternalUnifiedEvent' 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. ExternalUnifiedEvent: required: - eventType - id - objectId - objectType - occurredAt - properties type: object properties: eventType: type: string description: >- O formato da string "eventType" é "ae{appId}_{eventTypeLabel}", "pe{portalId}_{eventTypeLabel}" ou simplesmente "e_{eventTypeLabel}" para os eventos do HubSpot. id: type: string description: Um identificador exclusivo para o evento. objectId: type: string description: O objectId do objeto que realizou o evento. objectType: type: string description: O objectType do objeto que realizou o evento. occurredAt: type: string description: A data e hora ISO 8601 em que o evento ocorreu. format: date-time properties: type: object additionalProperties: type: string description: >- Um mapa de chave-valor de propriedades específicas do evento. As propriedades disponíveis dependem da definição do tipo de evento. 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 token de cursor a ser passado como o parâmetro de consulta "after" para recuperar a próxima página de resultados. link: type: string description: >- O URL completo da próxima página de resultados, com o token de cursor "after" incluído como um parâmetro de consulta. 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: >- O token de cursor a ser passado como o parâmetro de consulta "before" para recuperar a página anterior de resultados. link: type: string description: >- O URL completo da página de resultados anterior, com o token de cursor "before" incluído como um parâmetro de consulta. description: >- especifica as informações de paginação necessárias para recuperar o conjunto anterior de resultados em uma resposta de API paginada 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. responses: Error: description: An error occurred. content: '*/*': schema: $ref: '#/components/schemas/Error' ````