Search dashboards

curl --request GET \
  --url https://api.hubapi.com/analytics/reporting/2027-03-beta/dashboards \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.hubapi.com/analytics/reporting/2027-03-beta/dashboards"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.hubapi.com/analytics/reporting/2027-03-beta/dashboards', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/analytics/reporting/2027-03-beta/dashboards",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/analytics/reporting/2027-03-beta/dashboards"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/analytics/reporting/2027-03-beta/dashboards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "results": [
    {
      "archived": true,
      "businessUnitId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "name": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "archivedAt": "2023-11-07T05:31:56Z",
      "createdByUserId": "<string>",
      "description": "<string>",
      "lastViewedAt": "2023-11-07T05:31:56Z",
      "lastViewedByUserId": "<string>",
      "ownerUserId": "<string>",
      "permissions": {
        "permissionType": "EVERYONE_EDIT",
        "specificPermissions": [
          {
            "permissionType": "EDIT",
            "grants": [
              {
                "grantType": "TEAM",
                "granteeId": "<string>"
              }
            ]
          }
        ]
      },
      "tags": [
        {
          "id": "<string>",
          "name": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "createdByUserId": "<string>",
          "updatedAt": "2023-11-07T05:31:56Z",
          "updatedByUserId": "<string>"
        }
      ],
      "updatedByUserId": "<string>",
      "widgets": [
        {
          "reportId": "<string>",
          "widgetLayout": {
            "height": 123,
            "width": 123,
            "x": 123,
            "y": 123
          },
          "report": {
            "archived": true,
            "businessUnitId": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "id": "<string>",
            "name": "<string>",
            "updatedAt": "2023-11-07T05:31:56Z",
            "archivedAt": "2023-11-07T05:31:56Z",
            "createdByUserId": "<string>",
            "description": "<string>",
            "lastViewedAt": "2023-11-07T05:31:56Z",
            "lastViewedByUserId": "<string>",
            "ownerUserId": "<string>",
            "permissions": {
              "permissionType": "EVERYONE_EDIT",
              "specificPermissions": {
                "permissionType": "EDIT",
                "grants": [
                  {
                    "grantType": "TEAM",
                    "granteeId": "<string>"
                  }
                ]
              }
            },
            "tags": [
              {
                "id": "<string>",
                "name": "<string>",
                "createdAt": "2023-11-07T05:31:56Z",
                "createdByUserId": "<string>",
                "updatedAt": "2023-11-07T05:31:56Z",
                "updatedByUserId": "<string>"
              }
            ],
            "updatedByUserId": "<string>"
          }
        }
      ]
    }
  ],
  "total": 123,
  "paging": {
    "next": {
      "after": "<string>",
      "link": "<string>"
    },
    "prev": {
      "before": "<string>",
      "link": "<string>"
    }
  }
}

{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

Search dashboards

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

Search dashboards

curl --request GET \
  --url https://api.hubapi.com/analytics/reporting/2027-03-beta/dashboards \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.hubapi.com/analytics/reporting/2027-03-beta/dashboards"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.hubapi.com/analytics/reporting/2027-03-beta/dashboards', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/analytics/reporting/2027-03-beta/dashboards",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/analytics/reporting/2027-03-beta/dashboards"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/analytics/reporting/2027-03-beta/dashboards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "results": [
    {
      "archived": true,
      "businessUnitId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "name": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "archivedAt": "2023-11-07T05:31:56Z",
      "createdByUserId": "<string>",
      "description": "<string>",
      "lastViewedAt": "2023-11-07T05:31:56Z",
      "lastViewedByUserId": "<string>",
      "ownerUserId": "<string>",
      "permissions": {
        "permissionType": "EVERYONE_EDIT",
        "specificPermissions": [
          {
            "permissionType": "EDIT",
            "grants": [
              {
                "grantType": "TEAM",
                "granteeId": "<string>"
              }
            ]
          }
        ]
      },
      "tags": [
        {
          "id": "<string>",
          "name": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "createdByUserId": "<string>",
          "updatedAt": "2023-11-07T05:31:56Z",
          "updatedByUserId": "<string>"
        }
      ],
      "updatedByUserId": "<string>",
      "widgets": [
        {
          "reportId": "<string>",
          "widgetLayout": {
            "height": 123,
            "width": 123,
            "x": 123,
            "y": 123
          },
          "report": {
            "archived": true,
            "businessUnitId": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "id": "<string>",
            "name": "<string>",
            "updatedAt": "2023-11-07T05:31:56Z",
            "archivedAt": "2023-11-07T05:31:56Z",
            "createdByUserId": "<string>",
            "description": "<string>",
            "lastViewedAt": "2023-11-07T05:31:56Z",
            "lastViewedByUserId": "<string>",
            "ownerUserId": "<string>",
            "permissions": {
              "permissionType": "EVERYONE_EDIT",
              "specificPermissions": {
                "permissionType": "EDIT",
                "grants": [
                  {
                    "grantType": "TEAM",
                    "granteeId": "<string>"
                  }
                ]
              }
            },
            "tags": [
              {
                "id": "<string>",
                "name": "<string>",
                "createdAt": "2023-11-07T05:31:56Z",
                "createdByUserId": "<string>",
                "updatedAt": "2023-11-07T05:31:56Z",
                "updatedByUserId": "<string>"
              }
            ],
            "updatedByUserId": "<string>"
          }
        }
      ]
    }
  ],
  "total": 123,
  "paging": {
    "next": {
      "after": "<string>",
      "link": "<string>"
    },
    "prev": {
      "before": "<string>",
      "link": "<string>"
    }
  }
}

{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

Supported products

Required Scopes

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

after

string

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

archived

boolean

Whether to retrieve archived dashboards only. Default false.

businessUnitIds

string[]

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

createdAfter

string<date-time>

Filter to dashboards created after the specified date and time.

createdBefore

string<date-time>

Filter to dashboards created before the specified date and time.

ids

string[]

Filter to dashboards with the specified IDs.

limit

integer<int32>

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

onlyFavorites

boolean

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

ownerUserIds

string[]

Filter to dashboards owned by the specified users.

properties

string[]

Additionally properties to include in the response. Refer to the response details for available fields.

string

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

sort

string[]

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

tagIds

string[]

Filter to dashboards tagged with the specified tags.

updatedAfter

string<date-time>

Filter to dashboards updated after the specified date and time.

updatedBefore

string<date-time>

Filter to dashboards updated before the specified date and time.

Response

successful operation

results

object[]

required

An array of dashboards objects.

Show child attributes

total

integer<int32>

required

The total number of dashboards available.

paging

object

Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.

Show child attributes

Last modified on September 15, 2026