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

# Search reports

> Pesquisa e retorna páginas de relatórios usando uma variedade de filtros. A pesquisa utiliza consistência eventual; alterações nos relatórios podem levar alguns segundos para aparecer nos resultados da pesquisa.

Também oferece suporte à recuperação de páginas de relatórios arquivados, no entanto, aplicam-se as seguintes restrições: apenas os parâmetros "limit" e "after" são respeitados, todos os outros são ignorados; a recuperação de painéis arquivados não oferece suporte a filtragem, classificação personalizada ou projeção de propriedades. Os resultados são sempre retornados do mais recente para o menos recente em termos de exclusão.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/2027-03-beta/analytics-reporting-v2027-03-beta.json GET /analytics/reporting/2027-03-beta/reports
openapi: 3.0.1
info:
  title: Analytics Reporting
  description: Basepom for all HubSpot Projects
  version: 2027-03-beta
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Batch
  - name: Dashboards
  - name: Reports
paths:
  /analytics/reporting/2027-03-beta/reports:
    get:
      tags:
        - Reports
      summary: Pesquisar relatórios
      description: >-
        Pesquisa e retorna páginas de relatórios usando uma variedade de
        filtros. A pesquisa utiliza consistência eventual; alterações nos
        relatórios podem levar alguns segundos para aparecer nos resultados da
        pesquisa.


        Também oferece suporte à recuperação de páginas de relatórios
        arquivados, no entanto, aplicam-se as seguintes restrições: apenas os
        parâmetros "limit" e "after" são respeitados, todos os outros são
        ignorados; a recuperação de painéis arquivados não oferece suporte a
        filtragem, classificação personalizada ou projeção de propriedades. Os
        resultados são sempre retornados do mais recente para o menos recente em
        termos de exclusão.
      operationId: get-/analytics/reporting/2027-03-beta/reports
      parameters:
        - name: after
          in: query
          description: >-
            Um token de cursor para paginação. Use o valor do campo
            paging.next.after da resposta anterior.
          required: false
          style: form
          explode: true
          schema:
            type: string
        - name: archived
          in: query
          description: 'Deve-se recuperar apenas relatórios arquivados. Padrão: falso.'
          required: false
          style: form
          explode: true
          schema:
            type: boolean
        - name: businessUnitIds
          in: query
          description: >-
            Filtre relatórios que fazem parte das unidades de negócio
            especificadas.
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: createdAfter
          in: query
          description: Filtrar relatórios criados após uma data e hora específica.
          required: false
          style: form
          explode: true
          schema:
            type: string
            format: date-time
        - name: createdBefore
          in: query
          description: Filtrar relatórios criados antes de uma data e hora específicas.
          required: false
          style: form
          explode: true
          schema:
            type: string
            format: date-time
        - name: dashboardId
          in: query
          description: Filtre relatórios no painel especificado.
          required: false
          style: form
          explode: true
          schema:
            type: string
        - name: ids
          in: query
          description: Filtre relatórios com os IDs especificados.
          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. Padrão
            25, máximo 100.
          required: false
          style: form
          explode: true
          schema:
            type: integer
            format: int32
        - name: onDashboard
          in: query
          description: >-
            Filtre relatórios que estão, ou não estão, em qualquer painel.
            Desativado por padrão.
          required: false
          style: form
          explode: true
          schema:
            type: boolean
        - name: onlyFavorites
          in: query
          description: >-
            Filtre apenas para relatórios favoritados pelo usuário solicitante.
            Padrão: falso.
          required: false
          style: form
          explode: true
          schema:
            type: boolean
        - name: ownerUserIds
          in: query
          description: Filtre relatórios de propriedade dos usuários especificados.
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: properties
          in: query
          description: >-
            Propriedades adicionais a serem incluídas na resposta. Os valores
            válidos são: "dashboardIds", "permissions", "tags".
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: q
          in: query
          description: >-
            Filtre relatórios cujo nome ou descrição contenha a string de
            pesquisa.
          required: false
          style: form
          explode: true
          schema:
            type: string
        - name: sort
          in: query
          description: >-
            Selecione o campo e a direção. Os campos compatíveis são `name`,
            `updatedAt` e `lastViewedAt`. O padrão é `-updatedAt`
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: tagIds
          in: query
          description: Filtre relatórios marcados com as tags especificadas.
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: updatedAfter
          in: query
          description: Filtrar relatórios atualizados após uma data e hora específicas.
          required: false
          style: form
          explode: true
          schema:
            type: string
            format: date-time
        - name: updatedBefore
          in: query
          description: Filtrar relatórios atualizados antes de uma data e hora específicas.
          required: false
          style: form
          explode: true
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponseWithTotalPublicReport'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - reporting.full.read
        - oauth2:
            - reporting.full.admin
        - oauth2:
            - crm.hubsql.execute
components:
  schemas:
    CollectionResponseWithTotalPublicReport:
      required:
        - results
        - total
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/Paging'
        results:
          type: array
          description: Uma matriz de objetos de relatório.
          items:
            $ref: '#/components/schemas/PublicReport'
        total:
          type: integer
          description: O número total de relatórios disponíveis.
          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.
    PublicReport:
      required:
        - archived
        - businessUnitId
        - createdAt
        - id
        - name
        - updatedAt
      type: object
      properties:
        archived:
          type: boolean
          description: Se o relatório foi arquivado.
        archivedAt:
          type: string
          description: >-
            Se o relatório foi arquivado, a data e a hora em que o relatório foi
            arquivado, no formato ISO 8601. Ausente se o relatório não foi
            arquivado.
          format: date-time
        businessUnitId:
          type: string
          description: O ID da unidade de negócios ao qual o relatório está associado.
        createdAt:
          type: string
          description: A data e a hora em que o relatório foi criado, no formato ISO 8601.
          format: date-time
        createdByUserId:
          type: string
          description: O ID do usuário que criou o relatório. Pode estar ausente.
        dashboardIds:
          type: array
          description: >-
            Matriz de IDs dos painéis em que este relatório está.


            Para endpoints GET, só é retornada quando solicitada por meio da
            inclusão do campo "dashboardIds" no parâmetro de consulta
            "properties". Para outros endpoints, não é retornada.
          items:
            type: string
        description:
          type: string
          description: Uma descrição do relatório. Pode estar ausente.
        id:
          type: string
          description: O ID do relatório.
        lastViewedAt:
          type: string
          description: >-
            A data e a hora em que o relatório foi visualizado pela última vez,
            no formato ISO 8601. Ausente se ainda não tiver sido visualizado.
          format: date-time
        lastViewedByUserId:
          type: string
          description: >-
            O ID do usuário que visualizou o relatório pela última vez. Ausente
            se ainda não tiver sido visualizado.
        name:
          type: string
          description: O nome do relatório.
        ownerUserId:
          type: string
          description: >-
            O ID do usuário que possui o relatório. Ausente se o relatório não
            tiver proprietário no momento.
        permissions:
          $ref: '#/components/schemas/PublicReportPermissions'
        tags:
          type: array
          description: >-
            Matriz de objetos que representam as tags com as quais o relatório
            está marcado.


            Para endpoints GET, é retornado apenas quando solicitado por meio da
            inclusão do campo "tags" no parâmetro de consulta "properties". Para
            outros endpoints, é retornado quando aplicável.
          items:
            $ref: '#/components/schemas/PublicTag'
        updatedAt:
          type: string
          description: >-
            A data e a hora em que o relatório foi atualizado pela última vez,
            no formato ISO 8601.
          format: date-time
        updatedByUserId:
          type: string
          description: >-
            O ID do usuário que atualizou o relatório pela última vez. Pode
            estar ausente.
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: A categoria do erro, representada como uma string.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: >-
            Um objeto que fornece contexto sobre a condição de erro, com
            propriedades adicionais como matrizes de strings.
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Um identificador exclusivo para a solicitação, usado para fins de
            rastreamento e suporte. É uma string formatada como um UUID.
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: >-
            Uma matriz contendo mais informações sobre o erro, com cada item
            sendo um objeto ErrorDetail.
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um mapa que associa nomes de links a URIs correspondentes, contendo
            documentação sobre o erro ou etapas recomendadas para correção.
            Trata-se de um objeto com propriedades do tipo string.
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado. É uma string.
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Uma categoria específica que fornece informações mais detalhadas
            sobre o erro. É uma string.
      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: >-
            Um token de string que representa o cursor para a próxima página de
            resultados.
        link:
          type: string
          description: Um URL de string que leva para a próxima página de resultados.
      description: >-
        Specifies the paging information needed to retrieve the next set of
        results in a paginated API response
    PreviousPage:
      required:
        - before
      type: object
      properties:
        before:
          type: string
          description: >-
            Um token de string que representa o cursor para a página anterior de
            resultados.
        link:
          type: string
          description: Um URL de string que leva para a página de resultados anterior.
      description: >-
        specifies the paging information needed to retrieve the previous set of
        results in a paginated API response
    PublicReportPermissions:
      required:
        - permissionType
      type: object
      properties:
        permissionType:
          type: string
          description: >-
            O tipo de permissão a ser aplicado ao relatório. Os valores válidos
            são:

            - PRIVATE: o relatório é acessível apenas ao seu proprietário e
            administradores.

            - EVERYONE_VIEW: o relatório pode ser visualizado por todos.

            - EVERYONE_EDIT: o relatório pode ser visualizado e editado por
            todos.

            - SPECIFIC: além do proprietário, usuários e/ou equipes específicas
            recebem permissões de VIEW ou EDIT. O campo `specificPermissions`
            também deve estar presente.
          enum:
            - EVERYONE_EDIT
            - EVERYONE_VIEW
            - PRIVATE
            - SPECIFIC
        specificPermissions:
          $ref: '#/components/schemas/PublicSpecificPermissionConfig'
    PublicTag:
      required:
        - id
        - name
      type: object
      properties:
        createdAt:
          type: string
          description: >-
            A data e a hora em que a tag foi criada, no formato ISO 8601. Pode
            estar ausente.
          format: date-time
        createdByUserId:
          type: string
          description: O ID do usuário que criou a tag. Pode estar ausente.
        id:
          type: string
          description: O ID da tag.
        name:
          type: string
          description: O nome da tag.
        updatedAt:
          type: string
          description: >-
            A data e a hora da última atualização da tag, no formato ISO 8601.
            Pode estar ausente.
          format: date-time
        updatedByUserId:
          type: string
          description: >-
            O ID do usuário que atualizou a tag pela última vez. Pode estar
            ausente.
    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 de erro, representado como um objeto com
            propriedades adicionais que são arrays de strings.
          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 detalhes mais específicos sobre
            o erro. Esta é uma propriedade de string.
      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.
    PublicSpecificPermissionConfig:
      required:
        - permissionType
      type: object
      properties:
        grants:
          type: array
          description: >-
            Uma matriz de concessões que detalha os usuários e/ou equipes aos
            quais conceder a permissão específica. Pelo menos um beneficiário
            deve ser especificado.
          items:
            $ref: '#/components/schemas/PublicPermissionGrant'
        permissionType:
          type: string
          description: O tipo de permissão concedida, "VIEW" ou "EDIT".
          enum:
            - EDIT
            - VIEW
    PublicPermissionGrant:
      required:
        - grantType
        - granteeId
      type: object
      properties:
        grantType:
          type: string
          description: >-
            O tipo de entidade para a qual conceder permissões, sendo "USER" ou
            "TEAM".
          enum:
            - TEAM
            - USER
        granteeId:
          type: string
          description: O ID do usuário ou da equipe para o qual conceder permissões.
  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.hubsql.execute: ''
            reporting.full.admin: ''
            reporting.full.edit: ''
            reporting.full.read: ''
            reporting.full.write: ''

````