Learn about the CrmReport component for use in UI extensions.
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.
Prop | Type | Description |
---|---|---|
reportId | 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:
|