Sign in
Reports

Get report

Changed on

Retrieves a single report.

Also supports retrieving archived reports via the archived query parameter. Retrieving archived reports requires the requesting user to be the report owner, a reporting admin, or a super admin.

get/analytics/reporting/2027-03-beta/reports/{reportId}

Request

  • Base URL: https://api.hubapi.com
  • URL: https://api.hubapi.com/analytics/reporting/2027-03-beta/reports/{reportId}
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: reporting.full.read)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: reporting.full.admin)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.hubsql.execute)

Path parameters

reportIdinteger required

The ID of the report to retrieve.

Query parameters

archivedboolean

Whether to retrieve an archived dashboard instead of an active one. Default false.

propertiesstring[]

Additional properties to include in the response. Valid values are: dashboardIds, permissions, tags.

Response

successful operation

archivedboolean required

Whether the report is archived.

archivedAtstring date-time

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.

businessUnitIdstring required

The ID of the business unit that the report is associated with.

createdAtstring date-time required

The date and time when the report was created, in ISO 8601 format.

createdByUserIdstring

The ID of the user who created the report. May be absent.

dashboardIdsstring[]

Array of IDs of the dashboards that this report is on.

For GET endpoints, only returned when requested by including the dashboardIds field in the properties query parameter. For other endpoints, not returned.

descriptionstring

A description of the report. May be absent.

idstring required

The ID of the report.

lastViewedAtstring date-time

The date and time when the report was last viewed, in ISO 8601 format. Absent if it has not been viewed yet.

lastViewedByUserIdstring

The ID of the user who last viewed the report. Absent if it has not been viewed yet.

namestring required

The name of the report.

ownerUserIdstring

The ID of the user who owns the report. Absent if the report is currently unowned.

updatedAtstring date-time required

The date and time when the report was last updated, in ISO 8601 format.

updatedByUserIdstring

The ID of the user who last updated the report. May be absent.

Changes

  • 2027-03-beta2d237e903dfcRevision changes
    • ○

      the security scope reporting.full.read was added to the endpoint's security scheme oauth2

    • ○

      the security scope crm.hubsql.execute was removed from the endpoint's security scheme oauth2

  • 2027-03-betaae16703bd7c6Revision changes
    • ○

      the security scope reporting.full.read was added to the endpoint's security scheme oauth2

    • ○

      the security scope crm.hubsql.execute was removed from the endpoint's security scheme oauth2

    • ○

      added the optional property to the response with the status