Sign in
Reports

Search reports

Changed on

Searches for and returns pages of reports using a variety of filters. Search is eventually-consistent; changes to dashboards may take a few seconds to reflect in search results.

Also supports retrieving pages of archived reports; however, the following restrictions apply: only the limit and after parameters are respected, all others are ignored; archived report retrieval does not support filtering, custom sorting, or property projection. Results are always returned in order from most recently deleted to least recently deleted.

get/analytics/reporting/2027-03-beta/reports

Request

  • Base URL: https://api.hubapi.com
  • URL: https://api.hubapi.com/analytics/reporting/2027-03-beta/reports
  • 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)

Query parameters

afterstring

A cursor token for pagination. Use the value from the previous response's paging.next.after field.

archivedboolean

Whether to retrieve archived reports only. Default false.

businessUnitIdsstring[]

Filter to reports that are a part of the specified business units.

createdAfterstring date-time

Filter to reports created after a specific date and time.

createdBeforestring date-time

Filter to reports created before a specific date and time.

dashboardIdstring

Filter to reports on the specified dashboard.

idsstring[]

Filter to reports with the specified IDs.

limitinteger

The maximum number of results to display per page. Default 25, max 100.

onDashboardboolean

Filter to reports that are on, or not on, any dashboard. Unset by default.

onlyFavoritesboolean

Filter to only reports that are favorited by the requesting user. Default false.

ownerUserIdsstring[]

Filter to reports owned by the specified users.

propertiesstring[]

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

qstring

Filter to reports whose name or description contains the search string.

sortstring[]

Sort field and direction. Supported fields are name, updatedAt, and lastViewedAt. Defaults to -updatedAt

tagIdsstring[]

Filter to reports tagged with the specified tags.

updatedAfterstring date-time

Filter to reports updated after a specific date and time.

updatedBeforestring date-time

Filter to reports updated before a specific date and time.

Response

successful operation

totalinteger required

The total number of reports available.

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