> ## Documentation Index > Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Create dashboard > Creates a new dashboard. Existing reports can optionally be attached to the dashboard at creation time; report widgets will be appended sequentially. Attaching reports to the dashboard is done on a best-effort basis, and it's possible that some or all reports may fail to be attached. The dashboard will still be created, and no error will be returned. The requestor should check the `widgets` field in the response object to see which reports were successfully attached. export const UserLevelAccessCallout = () =>
Supports user-level access.
; export const ScopesList = ({scopes = [], description = "This API requires one of the following scopes:"}) => { if (!scopes || scopes.length === 0) { return null; } const sortedScopes = scopes.sort((a, b) => a.localeCompare(b)); return
{description}
{sortedScopes.map((scope, index) =>
{scope}
)}
; }; export const SupportedProducts = ({marketing, sales, service, cms, data, commerce, crm, marketingLevel, salesLevel, serviceLevel, cmsLevel, dataLevel, commerceLevel, crmLevel}) => { const translations = { description: "Requires one of the following products or higher.", productNames: { marketing: "Marketing Hub", sales: "Sales Hub", service: "Service Hub", cms: "Content Hub", data: "Data Hub", commerce: "Revenue Hub", crm: "Smart CRM" }, tiers: { free: "Free", starter: "Starter", professional: "Professional", enterprise: "Enterprise" } }; const translateTier = tier => { if (!tier) return ''; const lowerTier = tier.toLowerCase(); return translations.tiers[lowerTier] || tier; }; const products = [{ name: marketing ? translations.productNames.marketing : '', level: translateTier(marketingLevel), icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/MarketingHub.svg", alt: "Marketing Hub" }, { name: sales ? translations.productNames.sales : '', level: translateTier(salesLevel), icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/SalesHub.svg", alt: "Sales Hub" }, { name: service ? translations.productNames.service : '', level: translateTier(serviceLevel), icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/ServiceHub.svg", alt: "Service Hub" }, { name: cms ? translations.productNames.cms : '', level: translateTier(cmsLevel), icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/ContentHub.svg", alt: "Content Hub" }, { name: data ? translations.productNames.data : '', level: translateTier(dataLevel), icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/DataHub.svg", alt: "Data Hub" }, { name: commerce ? translations.productNames.commerce : '', level: translateTier(commerceLevel), icon: "https://www.hubspot.com/hubfs/Knowledge_Base/subscription_key_icons/commerce_icon.svg", alt: "Revenue Hub" }, { name: crm ? translations.productNames.crm : '', level: translateTier(crmLevel), icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/SmartCRM.svg", alt: "Smart CRM" }].filter(product => product.name && product.level); if (products.length === 0) return null; return
{translations.description}
{products.map((product, index) =>
{product.alt} {product.name} - {product.level}
)}
; }; ## OpenAPI ````yaml specs/2027-03-beta/analytics-reporting-v2027-03-beta.json POST /analytics/reporting/2027-03-beta/dashboards 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: Dashboards - name: Reports paths: /analytics/reporting/2027-03-beta/dashboards: post: tags: - Dashboards summary: Create dashboard description: >- Creates a new dashboard. Existing reports can optionally be attached to the dashboard at creation time; report widgets will be appended sequentially. Attaching reports to the dashboard is done on a best-effort basis, and it's possible that some or all reports may fail to be attached. The dashboard will still be created, and no error will be returned. The requestor should check the `widgets` field in the response object to see which reports were successfully attached. operationId: post-/analytics/reporting/2027-03-beta/dashboards parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/PublicDashboardCreateRequest' required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/PublicDashboard' default: $ref: '#/components/responses/Error' description: '' security: - oauth2: - reporting.full.write - oauth2: - reporting.full.admin components: schemas: PublicDashboardCreateRequest: required: - name - permissions type: object properties: businessUnitId: type: string description: >- The ID of the business unit to associate the new dashboard with. Optional, the account's default is used by default. description: type: string description: A description of the new dashboard. Optional. name: type: string description: The name of the new dashboard. permissions: $ref: '#/components/schemas/PublicDashboardPermissions' reportIdsToAdd: type: array description: >- Array of IDs of reports that should be added to the dashboard after creation. Optional. items: type: string PublicDashboard: required: - archived - businessUnitId - createdAt - id - name - updatedAt type: object properties: archived: type: boolean description: Whether the dashboard is archived. archivedAt: type: string description: >- If the dashboard is archived, the date and time when the dashboard was archived, in ISO 8601 format. Absent if the dashboard is not archived. format: date-time businessUnitId: type: string description: The ID of the business unit that the dashboard is associated with. createdAt: type: string description: >- The date and time when the dashboard was created, in ISO 8601 format. format: date-time createdByUserId: type: string description: The ID of the user who created the dashboard. May be absent. description: type: string description: A description of the dashboard. May be absent. id: type: string description: The ID of the dashboard. lastViewedAt: type: string description: >- The date and time when the dashboard was last viewed, in ISO 8601 format. Absent if it has not been viewed yet. format: date-time lastViewedByUserId: type: string description: >- The ID of the user who last viewed the dashboard. Absent if it has not been viewed yet. name: type: string description: The name of the dashboard. ownerUserId: type: string description: >- The ID of the user who owns the dashboard. Absent if the dashboard is currently unowned. permissions: $ref: '#/components/schemas/PublicDashboardPermissions' tags: type: array description: >- Array of objects representing the tags that the dashboard is tagged with. Only returned when requested by including the `tags` field in the `properties` query parameter. items: $ref: '#/components/schemas/PublicTag' updatedAt: type: string description: >- The date and time when the dashboard was last updated, in ISO 8601 format. format: date-time updatedByUserId: type: string description: The ID of the user who last updated the dashboard. May be absent. widgets: type: array description: >- An array of objects representing the widgets on the dashboard. Only returned when requested by including the `widgets` field in the `properties` query parameter. items: $ref: '#/components/schemas/PublicDashboardWidget' PublicDashboardPermissions: required: - permissionType type: object properties: permissionType: type: string description: >- The type of permission to apply to the report. Valid values are: - PRIVATE: The report is only accessible to its owner and administrators. - EVERYONE_VIEW: The report is viewable by everyone. - EVERYONE_EDIT: The report is viewable and editable by everyone. - SPECIFIC: In addition to the owner, specific users and/or teams are granted VIEW or EDIT permissions. The `specificPermissions` field must also be present. enum: - EVERYONE_EDIT - EVERYONE_VIEW - PRIVATE - SPECIFIC specificPermissions: type: array description: >- Array of specific permission grants. Must be present when `permissionType` is set to `SPECIFIC`, ignored otherwise. Dashboards can have one or two specific permission configurations: one for VIEW grants and/or one for EDIT grants. Specific users and/or teams receive either VIEW or EDIT permissions based on which configuration they appear in. A given user or team cannot appear in both VIEW and EDIT configurations. items: $ref: '#/components/schemas/PublicSpecificPermissionConfig' PublicTag: required: - id - name type: object properties: createdAt: type: string description: >- The date and time when the tag was created, in ISO 8601 format. May be absent. format: date-time createdByUserId: type: string description: The ID of the user who created the tag. May be absent. id: type: string description: The ID for the tag. name: type: string description: The name of the tag. updatedAt: type: string description: >- The date and time when the tag was last updated, in ISO 8601 format. May be absent. format: date-time updatedByUserId: type: string description: The ID of the user who last updated the tag. May be absent. PublicDashboardWidget: required: - reportId - widgetLayout type: object properties: report: $ref: '#/components/schemas/PublicReport' reportId: type: string description: The ID of the report the widget contains. widgetLayout: $ref: '#/components/schemas/PublicDashboardWidgetLayout' Error: required: - category - correlationId - message type: object properties: category: type: string description: The error category, represented as a string. context: type: object additionalProperties: type: array items: type: string description: >- An object providing context about the error condition, with additional properties as arrays of strings. example: >- {invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]} correlationId: type: string description: >- A unique identifier for the request, used for tracking and support purposes. It is a string formatted as a UUID. format: uuid example: aeb5f871-7f07-4993-9211-075dc63e7cbf errors: type: array description: >- An array containing further information about the error, with each item being an ErrorDetail object. items: $ref: '#/components/schemas/ErrorDetail' links: type: object additionalProperties: type: string description: >- A map of link names to associated URIs containing documentation about the error or recommended remediation steps. It is an object with string properties. message: type: string description: >- A human readable message describing the error along with remediation steps where appropriate. It is a string. example: An error occurred subCategory: type: string description: >- A specific category providing more detailed information about the error. It is a string. description: >- Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered. 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: >- An array of grants detailing the users and/or teams to grant the specific permission to. At least one grantee must be specified. items: $ref: '#/components/schemas/PublicPermissionGrant' permissionType: type: string description: The type of permission granted, either `VIEW` or `EDIT`. enum: - EDIT - VIEW PublicReport: required: - archived - businessUnitId - createdAt - id - name - updatedAt type: object properties: archived: type: boolean description: Whether the report is archived. archivedAt: type: string description: >- If the report is archived, the date and time when the report was archived, in ISO 8601 format. Absent if the report is not archived. format: date-time businessUnitId: type: string description: The ID of the business unit that the report is associated with. createdAt: type: string description: The date and time when the report was created, in ISO 8601 format. format: date-time createdByUserId: type: string description: The ID of the user who created the report. May be absent. description: type: string description: A description of the report. May be absent. id: type: string description: The ID of the report. lastViewedAt: type: string description: >- The date and time when the report was last viewed, in ISO 8601 format. Absent if it has not been viewed yet. format: date-time lastViewedByUserId: type: string description: >- The ID of the user who last viewed the report. Absent if it has not been viewed yet. name: type: string description: The name of the report. ownerUserId: type: string description: >- The ID of the user who owns the report. Absent if the report is currently unowned. permissions: $ref: '#/components/schemas/PublicReportPermissions' tags: type: array description: >- Array of objects representing the tags that the report is tagged with. Only returned when requested by including the `tags` field in the `properties` query parameter. items: $ref: '#/components/schemas/PublicTag' updatedAt: type: string description: >- The date and time when the report was last updated, in ISO 8601 format. format: date-time updatedByUserId: type: string description: The ID of the user who last updated the report. May be absent. PublicDashboardWidgetLayout: required: - height - width - x - 'y' type: object properties: height: type: integer description: The height of the widget in the dashboard grid. format: int32 width: type: integer description: The width of the widget in the dashboard grid. format: int32 x: type: integer description: >- The 0-based absolute horizontal position of the widget in the dashboard grid. format: int32 'y': type: integer description: >- The 0-based absolute vertical position of the widget in the dashboard grid. format: int32 ErrorDetail: required: - message type: object properties: code: type: string description: The status code associated with the error detail. context: type: object additionalProperties: type: array items: type: string description: >- Context about the error condition, represented as an object with additional properties that are arrays of strings. example: '{missingScopes=[scope1, scope2]}' in: type: string description: The name of the field or parameter in which the error was found. message: type: string description: >- A human readable message describing the error along with remediation steps where appropriate. subCategory: type: string description: >- A specific category that contains more specific detail about the error. description: >- Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response. PublicPermissionGrant: required: - grantType - granteeId type: object properties: grantType: type: string description: The type of entity to grant permissions to, either `USER` or `TEAM`. enum: - TEAM - USER granteeId: type: string description: The ID of the user or team to grant permissions to. PublicReportPermissions: required: - permissionType type: object properties: permissionType: type: string description: >- The type of permission to apply to the report. Valid values are: - PRIVATE: The report is only accessible to its owner and administrators. - EVERYONE_VIEW: The report is viewable by everyone. - EVERYONE_EDIT: The report is viewable and editable by everyone. - SPECIFIC: In addition to the owner, specific users and/or teams are granted VIEW or EDIT permissions. The `specificPermissions` field must also be present. 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: '' ````