> ## 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 dashboard > Recupera um único painel. Também oferece suporte à recuperação de painéis arquivados por meio do parâmetro de consulta `archived`. A recuperação de painéis arquivados exige que o usuário solicitante seja o proprietário do painel, um administrador de relatórios ou um superadministrador. > **Supported products** > **Required Scopes** ## OpenAPI ````yaml specs/2027-03-beta/analytics-reporting-v2027-03-beta.json GET /analytics/reporting/2027-03-beta/dashboards/{dashboardId} 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/dashboards/{dashboardId}: get: tags: - Dashboards summary: Obter painel description: >- Recupera um único painel. Também oferece suporte à recuperação de painéis arquivados por meio do parâmetro de consulta `archived`. A recuperação de painéis arquivados exige que o usuário solicitante seja o proprietário do painel, um administrador de relatórios ou um superadministrador. operationId: get-/analytics/reporting/2027-03-beta/dashboards/{dashboardId} parameters: - name: dashboardId in: path description: O ID do painel a ser recuperado. required: true style: simple explode: false schema: type: integer format: int64 - name: archived in: query description: >- Recuperar ou não um painel arquivado em vez de um ativo. Padrão: falso. required: false style: form explode: true schema: type: boolean default: false - name: properties in: query description: >- Propriedades adicionais a serem incluídas na resposta. Os valores válidos são: "permissions", "tags", "widgets", "widgets.report". required: false style: form explode: true schema: type: array items: type: string responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/PublicDashboard' default: $ref: '#/components/responses/Error' description: '' security: - oauth2: - reporting.full.read - oauth2: - reporting.full.admin - oauth2: - crm.hubsql.execute components: schemas: PublicDashboard: required: - archived - businessUnitId - createdAt - id - name - updatedAt type: object properties: archived: type: boolean description: Se o painel foi arquivado. archivedAt: type: string description: >- Se o painel foi arquivado, a data e a hora em que isso aconteceu, no formato ISO 8601. Ausente se o painel não foi arquivado. format: date-time businessUnitId: type: string description: O ID da unidade de negócios à qual o painel está associado. createdAt: type: string description: A data e a hora em que o painel foi criado, no formato ISO 8601. format: date-time createdByUserId: type: string description: ID do usuário que criou o painel. Pode estar ausente. description: type: string description: Uma descrição do painel. Pode estar ausente. id: type: string description: O ID do painel. lastViewedAt: type: string description: >- A data e a hora em que o painel 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 painel pela última vez. Ausente se ainda não tiver sido visualizado. name: type: string description: O nome do painel. ownerUserId: type: string description: >- O ID do usuário que possui o painel. Ausente se o painel não tiver proprietário no momento. permissions: $ref: '#/components/schemas/PublicDashboardPermissions' tags: type: array description: >- Matriz de objetos que representam as tags com as quais o painel 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: Data e hora da última atualização do painel, no formato ISO 8601. format: date-time updatedByUserId: type: string description: >- O ID do usuário que atualizou o painel pela última vez. Pode estar ausente. widgets: type: array description: >- Uma matriz de objetos que representam os widgets no painel. Para endpoints GET, é retornado apenas quando solicitado por meio da inclusão do campo "widgets" no parâmetro de consulta "properties". Para outros endpoints, é retornado quando aplicável. items: $ref: '#/components/schemas/PublicDashboardWidget' PublicDashboardPermissions: 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: type: array description: >- Matriz de concessões de permissão específicas. Deve estar presente quando "permissionType" for definido como "SPECIFIC", caso contrário, será ignorado. Os painéis podem ter uma ou duas configurações de permissão específicas: uma para concessões de VIEW e/ou uma para concessões de EDIT. Usuários e/ou equipes específicas recebem permissões de VIEW ou EDIT com base na configuração em que aparecem. Um determinado usuário ou equipe não pode aparecer nas configurações de VIEW e EDIT. items: $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. PublicDashboardWidget: required: - reportId - widgetLayout type: object properties: report: $ref: '#/components/schemas/PublicReport' reportId: type: string description: O ID do relatório que o widget contém. widgetLayout: $ref: '#/components/schemas/PublicDashboardWidgetLayout' 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 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 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. PublicDashboardWidgetLayout: required: - height - width - x - 'y' type: object properties: height: type: integer description: A altura do widget na grade do painel. format: int32 width: type: integer description: A largura do widget na grade do painel. format: int32 x: type: integer description: >- A posição horizontal absoluta baseada em 0 do widget na grade do painel. format: int32 'y': type: integer description: >- A posição vertical absoluta baseada em 0 do widget na grade do painel. format: int32 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. 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. 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' 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: '' ````