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

# Search reports

> Recherche et renvoie des pages de rapports à l’aide de divers filtres. La recherche est éventuellement cohérente ; les modifications apportées aux tableaux de bord peuvent prendre quelques secondes avant de se refléter dans les résultats de recherche.

Prend également en charge la récupération de pages de rapports archivés ; cependant, les restrictions suivantes s’appliquent : seuls les paramètres `limit` et `after` sont respectés, tous les autres sont ignorés ; la récupération de rapports archivés ne prend pas en charge le filtrage, le tri personnalisé ou la projection de propriétés. Les résultats sont toujours renvoyés dans l’ordre du plus récemment supprimé au moins récemment supprimé.

> **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: Recherche de rapports
      description: "Recherche et renvoie des pages de rapports à l’aide de divers filtres. La recherche est éventuellement cohérente\_; les modifications apportées aux tableaux de bord peuvent prendre quelques secondes avant de se refléter dans les résultats de recherche.\n\nPrend également en charge la récupération de pages de rapports archivés\_; cependant, les restrictions suivantes s’appliquent\_: seuls les paramètres `limit` et `after` sont respectés, tous les autres sont ignorés\_; la récupération de rapports archivés ne prend pas en charge le filtrage, le tri personnalisé ou la projection de propriétés. Les résultats sont toujours renvoyés dans l’ordre du plus récemment supprimé au moins récemment supprimé."
      operationId: get-/analytics/reporting/2027-03-beta/reports
      parameters:
        - name: after
          in: query
          description: >-
            Un jeton de curseur pour la pagination. Utilisez la valeur du champ
            paging.next.after de la réponse précédente.
          required: false
          style: form
          explode: true
          schema:
            type: string
        - name: archived
          in: query
          description: >-
            Indique si seuls les rapports archivés doivent être récupérés. La
            valeur par défaut est faux.
          required: false
          style: form
          explode: true
          schema:
            type: boolean
        - name: businessUnitIds
          in: query
          description: >-
            Filtrer les rapports qui font partie des unités commerciales
            spécifiées.
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: createdAfter
          in: query
          description: Filtrer les rapports créés après une date et une heure précises.
          required: false
          style: form
          explode: true
          schema:
            type: string
            format: date-time
        - name: createdBefore
          in: query
          description: Filtrer les rapports créés avant une date et une heure spécifiques.
          required: false
          style: form
          explode: true
          schema:
            type: string
            format: date-time
        - name: dashboardId
          in: query
          description: Filtrer les rapports sur le tableau de bord spécifié.
          required: false
          style: form
          explode: true
          schema:
            type: string
        - name: ids
          in: query
          description: Filtrer les rapports avec les ID spécifiés.
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: limit
          in: query
          description: "Le nombre maximal de résultats à afficher par page. Par défaut\_: 25, max\_: 100."
          required: false
          style: form
          explode: true
          schema:
            type: integer
            format: int32
        - name: onDashboard
          in: query
          description: >-
            Filtrer les rapports qui figurent, ou non, sur un tableau de bord.
            Non défini par défaut.
          required: false
          style: form
          explode: true
          schema:
            type: boolean
        - name: onlyFavorites
          in: query
          description: "Filtrer pour n'afficher que les rapports favoris de l'utilisateur demandeur. Par défaut, la valeur est «\_false\_»."
          required: false
          style: form
          explode: true
          schema:
            type: boolean
        - name: ownerUserIds
          in: query
          description: Filtrer les rapports appartenant aux utilisateurs spécifiés.
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: properties
          in: query
          description: "Propriétés supplémentaires à inclure dans la réponse. Les valeurs valides sont\_: `dashboardIds`, `permissions`, `balises`."
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: q
          in: query
          description: >-
            Filtrer les rapports dont le nom ou la description contient la
            chaîne de recherche.
          required: false
          style: form
          explode: true
          schema:
            type: string
        - name: sort
          in: query
          description: "Champ de tri et direction. Les champs pris en charge sont «\_name\_», «\_updatedAt\_» et «\_lastViewedAt\_». La valeur par défaut est «\_-updatedAt\_»."
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: tagIds
          in: query
          description: Filtrer les rapports associés aux balises spécifiées.
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: updatedAfter
          in: query
          description: >-
            Filtrer les rapports mis à jour après une date et une heure
            spécifiques.
          required: false
          style: form
          explode: true
          schema:
            type: string
            format: date-time
        - name: updatedBefore
          in: query
          description: >-
            Filtrer les rapports mis à jour avant une date et une heure
            spécifiques.
          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: Un tableau d'objets de rapport.
          items:
            $ref: '#/components/schemas/PublicReport'
        total:
          type: integer
          description: Le nombre total de rapports disponibles.
          format: int32
    Paging:
      type: object
      properties:
        next:
          $ref: '#/components/schemas/NextPage'
        prev:
          $ref: '#/components/schemas/PreviousPage'
      description: >-
        Représente les informations de pagination pour naviguer dans une liste
        de résultats de l'API. Il fournit des détails sur la manière d'accéder à
        l'ensemble de résultats précédent ou suivant.
    PublicReport:
      required:
        - archived
        - businessUnitId
        - createdAt
        - id
        - name
        - updatedAt
      type: object
      properties:
        archived:
          type: boolean
          description: Indique si le rapport est archivé.
        archivedAt:
          type: string
          description: "Si le rapport est archivé, la date et l'heure de son archivage, au format ISO\_8601. Absent si le rapport n'est pas archivé."
          format: date-time
        businessUnitId:
          type: string
          description: L'ID de l'unité commerciale à laquelle le rapport est associé.
        createdAt:
          type: string
          description: La date et l'heure de création du rapport, au format ISO 8601.
          format: date-time
        createdByUserId:
          type: string
          description: >-
            L'identifiant de l'utilisateur qui a créé le rapport. Peut être
            absent.
        dashboardIds:
          type: array
          description: >-
            Tableau des identifiants des tableaux de bord sur lesquels se trouve
            ce rapport.


            Pour les points de terminaison GET, renvoyé uniquement lorsque
            demandé en incluant le champ `dashboardIds` dans le paramètre de
            requête `properties`. Pour les autres points de terminaison, non
            renvoyé.
          items:
            type: string
        description:
          type: string
          description: Description du rapport. Peut être absente.
        id:
          type: string
          description: L'ID du rapport.
        lastViewedAt:
          type: string
          description: "La date et l'heure de la dernière consultation du rapport, au format ISO\_8601. Absent si le rapport n'a pas encore été consulté."
          format: date-time
        lastViewedByUserId:
          type: string
          description: >-
            L'identifiant de l'utilisateur qui a consulté le rapport pour la
            dernière fois. Absent s'il n'a pas encore été consulté.
        name:
          type: string
          description: Le nom du rapport.
        ownerUserId:
          type: string
          description: >-
            L'identifiant de l'utilisateur qui possède le rapport. Absent si le
            rapport n'a actuellement pas de propriétaire.
        permissions:
          $ref: '#/components/schemas/PublicReportPermissions'
        tags:
          type: array
          description: >-
            Tableau d'objets représentant les balises associées au rapport.


            Pour les points de terminaison GET, le rapport est renvoyé
            uniquement lorsque demandé en incluant le champ `tags` dans le
            paramètre de requête `properties`. Pour les autres points de
            terminaison, le retour est effectué le cas échéant.
          items:
            $ref: '#/components/schemas/PublicTag'
        updatedAt:
          type: string
          description: >-
            La date et l'heure de la dernière mise à jour du rapport, au format
            ISO 8601.
          format: date-time
        updatedByUserId:
          type: string
          description: >-
            L'ID de l'utilisateur qui a mis à jour le rapport en dernier. Peut
            être absent.
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: >-
            La catégorie d'erreur, représentée sous forme de chaine de
            caractères.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: >-
            Un objet fournissant un contexte sur la condition d'erreur, avec des
            propriétés supplémentaires sous forme de tableaux de chaînes de
            caractères.
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Un identifiant unique pour la requête, utilisé à des fins de suivi
            et de support. Il s'agit d'une chaîne formatée comme un UUID.
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: >-
            Un tableau contenant des informations supplémentaires sur l'erreur,
            chaque élément étant un objet ErrorDetail.
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Une carte des noms de liens vers les URI associées contenant de la
            documentation sur l'erreur ou les étapes de correction recommandées.
            Il s'agit d'un objet avec des propriétés de chaîne.
        message:
          type: string
          description: >-
            Un message lisible par l'utilisateur décrivant l'erreur ainsi que
            les mesures correctives à prendre, le cas échéant. Il s'agit d'une
            chaîne de caractères.
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Une catégorie spécifique fournissant des informations plus
            détaillées sur l'erreur. Il s'agit d'une chaîne de caractères.
      description: >-
        Représente une réponse d'erreur renvoyée par l'API lorsqu'une opération
        échoue. Ce composant est utilisé dans divers points de terminaison pour
        fournir des informations détaillées sur l'erreur rencontrée.
      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: >-
            Un jeton de chaîne représentant le curseur pour la page de résultats
            suivante.
        link:
          type: string
          description: Une URL de chaîne qui renvoie à la page de résultats suivante.
      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: >-
            Un jeton de chaîne représentant le curseur pour la page précédente
            des résultats.
        link:
          type: string
          description: Une URL de chaîne qui renvoie à la page de résultats précédente.
      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: "Le type d'autorisation à appliquer au rapport. Les valeurs valides sont les suivantes\_:\n- PRIVATE\_: le rapport est uniquement accessible à son propriétaire et aux administrateur.\n- EVERYONE_VIEW\_: le rapport peut être consulté par tout le monde.\n- EVERYONE_EDIT\_: le rapport peut être consulté et modifié par tout le monde.\n- SPECIFIC\_: en plus du propriétaire, des utilisateurs et/ou des équipes spécifiques disposent d'autorisations de consultation ou de modification. Le champ `specificPermissions` doit également être présent."
          enum:
            - EVERYONE_EDIT
            - EVERYONE_VIEW
            - PRIVATE
            - SPECIFIC
        specificPermissions:
          $ref: '#/components/schemas/PublicSpecificPermissionConfig'
    PublicTag:
      required:
        - id
        - name
      type: object
      properties:
        createdAt:
          type: string
          description: "La date et l'heure de création de la balise, au format ISO\_8601. Peut être absent."
          format: date-time
        createdByUserId:
          type: string
          description: L'ID de l'utilisateur qui a créé la balise. Peut être absent.
        id:
          type: string
          description: L'ID de la balise.
        name:
          type: string
          description: Le nom du libellé.
        updatedAt:
          type: string
          description: "La date et l'heure de la dernière mise à jour de la balise, au format ISO\_8601. Peut être absent."
          format: date-time
        updatedByUserId:
          type: string
          description: >-
            L'ID de l'utilisateur qui a mis à jour la balise en dernier. Peut
            être absent.
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: >-
            Le code de statut associé au détail de l'erreur. Il s'agit d'une
            propriété de type chaîne de caractères.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: >-
            Contexte de la condition d'erreur, représenté sous la forme d'un
            objet avec des propriétés supplémentaires qui sont des tableaux de
            chaînes de caractères.
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: >-
            Le nom du champ ou du paramètre dans lequel l'erreur a été détectée.
            Il s'agit d'une propriété de type chaîne de caractères.
        message:
          type: string
          description: >-
            Un message lisible par la personne décrivant l'erreur ainsi que les
            étapes de remédiation appropriées, le cas échéant.
        subCategory:
          type: string
          description: >-
            Une catégorie spécifique qui contient des détails plus précis sur
            l'erreur. Il s'agit d'une propriété de type chaîne de caractères.
      description: >-
        Représente des informations détaillées sur une erreur survenue dans
        l'API. Ce composant est utilisé pour fournir un contexte et des
        spécificités supplémentaires sur les erreurs, généralement dans le cadre
        d'une réponse d'erreur.
    PublicSpecificPermissionConfig:
      required:
        - permissionType
      type: object
      properties:
        grants:
          type: array
          description: >-
            Un tableau de droits détaillant les utilisateurs et/ou les équipes
            auxquelles accorder l'autorisation spécifique. Au moins un
            bénéficiaire doit être spécifié.
          items:
            $ref: '#/components/schemas/PublicPermissionGrant'
        permissionType:
          type: string
          description: "Le type d'autorisation accordée, soit «\_VIEW\_» ou «\_EDIT\_»."
          enum:
            - EDIT
            - VIEW
    PublicPermissionGrant:
      required:
        - grantType
        - granteeId
      type: object
      properties:
        grantType:
          type: string
          description: "Le type d'entité à laquelle accorder des autorisations\_: «\_USER\_» (utilisateur) ou «\_TEAM\_» (équipe)."
          enum:
            - TEAM
            - USER
        granteeId:
          type: string
          description: >-
            L'ID de l'utilisateur ou de l'équipe à qui accorder les
            autorisations.
  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: ''

````