Sign in
Dashboards

Search dashboards

Changed on

Searches for and returns pages of dashboards 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 dashboards; however, the following restrictions apply: only the limit and after parameters are respected, all others are ignored; archived dashboard 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/dashboards

Request

  • Base URL: https://api.hubapi.com
  • URL: https://api.hubapi.com/analytics/reporting/2027-03-beta/dashboards
  • 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 dashboards only. Default false.

businessUnitIdsstring[]

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

createdAfterstring date-time

Filter to dashboards created after the specified date and time.

createdBeforestring date-time

Filter to dashboards created before the specified date and time.

idsstring[]

Filter to dashboards with the specified IDs.

limitinteger

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

onlyFavoritesboolean

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

ownerUserIdsstring[]

Filter to dashboards owned by the specified users.

propertiesstring[]

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

qstring

Filter to dashboards 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 dashboards tagged with the specified tags.

updatedAfterstring date-time

Filter to dashboards updated after the specified date and time.

updatedBeforestring date-time

Filter to dashboards updated before the specified date and time.

Response

successful operation

totalinteger required

The total number of dashboards 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