CrmReport | UI components (BETA)

APPLICABLE PRODUCTS
  • Sales Hub
    • Enterprise
  • Service Hub
    • Enterprise

The CrmReport component renders a single object report, which can be filtered with the use prop to surface data based on the currently displaying record, its associations, or unfiltered.

By default, the report data will automatically filter for the currently displaying record, as long as there is an association between the displaying record and records included in the report.

For example, using this component you can display a single object report that shows which deals closed this quarter. When viewing the report on a contact record, by default the report will only display data from deals associated with that contact.

ui-ext-components-report

This component requires you to specify the ID of the report to render. To get a report's ID:

  • In your HubSpot account, navigate to Reports > Reports.
  • Click the name of the report you want to display.
  • In the URL, copy the number that is not your HubID.

report-id-in-URL

Please note: report data will only display for users with permissions to view reports.
import { CrmReport } from '@hubspot/ui-extensions/crm'; const Extension = () => { return ( <CrmReport reportId="6339949" />; ); };
Prop Type Description
reportId Required String The numeric ID of the single object report, which can be found in the URL when viewing the report in HubSpot.
use 'associations' (default) |
'subject' |
'unfiltered'		 Specifies how the report should be filtered based on its relationship to the currently displaying CRM record:
  • associations: report will only include data from records associated with the currently displaying record.
  • subject: report will only include data from the currently displaying record. Will not include data from associated records.
  • unfiltered: report will display all data regardless of the currently displaying record and its associations.

Related components

Was this article helpful?
This form is used for documentation feedback only. Learn how to get help with HubSpot.