> ## 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.

# Get statistics histogram

> Obtenha estatísticas agregadas em intervalos para um período de tempo específico. Cada intervalo contém estatísticas agregadas dos e-mails que foram enviados nesse período.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/legacy/v3/marketing-marketing-emails-v3.json GET /marketing/v3/emails/statistics/histogram
openapi: 3.0.1
info:
  title: E-mails de marketing
  version: v3
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
  x-hubspot-api-use-case: >-
    Você deseja criar e-mails de marketing de forma programática e depois
    recuperar suas estatísticas de envio em um momento posterior.
  x-hubspot-related-documentation:
    - name: Marketing Emails Guide
      url: >-
        https://developers.hubspot.com/docs/guides/api/marketing/emails/marketing-emails
  x-hubspot-introduction: >-
    Use a API de e-mail de marketing para criar, gerenciar e obter detalhes
    sobre e-mails de marketing. Você também pode usar essa API para acessar
    estatísticas de envios de e-mail semelhantes às disponíveis no HubSpot.
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Basic
  - name: Emails
paths:
  /marketing/v3/emails/statistics/histogram:
    get:
      tags:
        - Basic
      summary: Obter intervalos de estatísticas agregadas
      description: >-
        Obtenha estatísticas agregadas em intervalos para um período de tempo
        específico. Cada intervalo contém estatísticas agregadas dos e-mails que
        foram enviados nesse período.
      operationId: get-/marketing/v3/emails/statistics/histogram_getHistogram
      parameters:
        - name: emailIds
          in: query
          description: >-
            Filtre por IDs de e-mail. Inclua apenas estatísticas de e-mails com
            esses IDs.
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: endTimestamp
          in: query
          description: A data e hora final do intervalo de tempo, em representação ISO8601.
          required: false
          style: form
          explode: true
          schema:
            type: string
            format: date-time
        - name: interval
          in: query
          description: O intervalo para o qual agregar estatísticas.
          required: false
          style: form
          explode: true
          schema:
            type: string
            enum:
              - DAY
              - HOUR
              - MINUTE
              - MONTH
              - QUARTER
              - QUARTER_HOUR
              - SECOND
              - WEEK
              - YEAR
        - name: startTimestamp
          in: query
          description: >-
            A data e hora inicial do intervalo de tempo, em representação
            ISO8601.
          required: false
          style: form
          explode: true
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/CollectionResponseWithTotalEmailStatisticInterval
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - marketing.email.read
        - oauth2:
            - marketing.email.write
        - oauth2:
            - content
components:
  schemas:
    CollectionResponseWithTotalEmailStatisticInterval:
      required:
        - results
        - total
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/Paging'
        results:
          type: array
          items:
            $ref: '#/components/schemas/EmailStatisticInterval'
        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.
    EmailStatisticInterval:
      required:
        - aggregations
        - interval
      type: object
      properties:
        aggregations:
          $ref: '#/components/schemas/EmailStatisticsData'
        interval:
          $ref: '#/components/schemas/Interval'
    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 valor do token do cursor para obter o próximo conjunto de
            resultados. Use este valor como parâmetro de consulta (&after=...)
            para obter a próxima página.
        link:
          type: string
          description: O 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: >-
            O valor do token do cursor para obter o conjunto anterior de
            resultados. Use este valor como parâmetro de consulta (&before=...)
            para obter a página anterior.
        link:
          type: string
          description: O link para a página anterior.
      description: >-
        especifica as informações de paginação necessárias para recuperar o
        conjunto anterior de resultados em uma resposta de API paginada
    EmailStatisticsData:
      required:
        - counters
        - deviceBreakdown
        - qualifierStats
        - ratios
      type: object
      properties:
        counters:
          type: object
          additionalProperties:
            type: integer
            format: int64
          description: Contadores como número de "sent", "open" ou "delivered".
        deviceBreakdown:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: integer
              format: int64
          description: Estatísticas por dispositivo.
        qualifierStats:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: integer
              format: int64
          description: Número de e-mails que foram descartados e rejeitados.
        ratios:
          type: object
          additionalProperties:
            type: number
          description: Taxas como "openratio" ou "clickratio"
    Interval:
      required:
        - end
        - start
      type: object
      properties:
        end:
          type: string
          description: A data e hora final do intervalo, no formato ISO8601.
          format: date-time
        start:
          type: string
          description: A data e hora inicial do intervalo, no formato ISO8601.
          format: date-time
    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'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            content: ''
            marketing-email: ''
            marketing.email.read: ''
            marketing.email.write: ''
            transactional-email: ''

````