Create dashboard

curl --request POST \
  --url https://api.hubapi.com/analytics/reporting/2027-03-beta/dashboards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "permissions": {
    "specificPermissions": [
      {
        "grants": [
          {
            "granteeId": "<string>"
          }
        ]
      }
    ]
  },
  "businessUnitId": "<string>",
  "description": "<string>",
  "reportIdsToAdd": [
    "<string>"
  ]
}
'

import requests

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

payload = {
    "name": "<string>",
    "permissions": { "specificPermissions": [{ "grants": [{ "granteeId": "<string>" }] }] },
    "businessUnitId": "<string>",
    "description": "<string>",
    "reportIdsToAdd": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    permissions: {specificPermissions: [{grants: [{granteeId: '<string>'}]}]},
    businessUnitId: '<string>',
    description: '<string>',
    reportIdsToAdd: ['<string>']
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'permissions' => [
        'specificPermissions' => [
                [
                                'grants' => [
                                                                [
                                                                                                                                'granteeId' => '<string>'
                                                                ]
                                ]
                ]
        ]
    ],
    'businessUnitId' => '<string>',
    'description' => '<string>',
    'reportIdsToAdd' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"permissions\": {\n    \"specificPermissions\": [\n      {\n        \"grants\": [\n          {\n            \"granteeId\": \"<string>\"\n          }\n        ]\n      }\n    ]\n  },\n  \"businessUnitId\": \"<string>\",\n  \"description\": \"<string>\",\n  \"reportIdsToAdd\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hubapi.com/analytics/reporting/2027-03-beta/dashboards")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"permissions\": {\n    \"specificPermissions\": [\n      {\n        \"grants\": [\n          {\n            \"granteeId\": \"<string>\"\n          }\n        ]\n      }\n    ]\n  },\n  \"businessUnitId\": \"<string>\",\n  \"description\": \"<string>\",\n  \"reportIdsToAdd\": [\n    \"<string>\"\n  ]\n}")
  .asString();

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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"permissions\": {\n    \"specificPermissions\": [\n      {\n        \"grants\": [\n          {\n            \"granteeId\": \"<string>\"\n          }\n        ]\n      }\n    ]\n  },\n  \"businessUnitId\": \"<string>\",\n  \"description\": \"<string>\",\n  \"reportIdsToAdd\": [\n    \"<string>\"\n  ]\n}"

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

{
  "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>"
      }
    }
  ]
}

{
  "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"
  }
}

POST

analytics

reporting

2027-03-beta

dashboards

Create dashboard

curl --request POST \
  --url https://api.hubapi.com/analytics/reporting/2027-03-beta/dashboards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "permissions": {
    "specificPermissions": [
      {
        "grants": [
          {
            "granteeId": "<string>"
          }
        ]
      }
    ]
  },
  "businessUnitId": "<string>",
  "description": "<string>",
  "reportIdsToAdd": [
    "<string>"
  ]
}
'

import requests

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

payload = {
    "name": "<string>",
    "permissions": { "specificPermissions": [{ "grants": [{ "granteeId": "<string>" }] }] },
    "businessUnitId": "<string>",
    "description": "<string>",
    "reportIdsToAdd": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    permissions: {specificPermissions: [{grants: [{granteeId: '<string>'}]}]},
    businessUnitId: '<string>',
    description: '<string>',
    reportIdsToAdd: ['<string>']
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'permissions' => [
        'specificPermissions' => [
                [
                                'grants' => [
                                                                [
                                                                                                                                'granteeId' => '<string>'
                                                                ]
                                ]
                ]
        ]
    ],
    'businessUnitId' => '<string>',
    'description' => '<string>',
    'reportIdsToAdd' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"permissions\": {\n    \"specificPermissions\": [\n      {\n        \"grants\": [\n          {\n            \"granteeId\": \"<string>\"\n          }\n        ]\n      }\n    ]\n  },\n  \"businessUnitId\": \"<string>\",\n  \"description\": \"<string>\",\n  \"reportIdsToAdd\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hubapi.com/analytics/reporting/2027-03-beta/dashboards")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"permissions\": {\n    \"specificPermissions\": [\n      {\n        \"grants\": [\n          {\n            \"granteeId\": \"<string>\"\n          }\n        ]\n      }\n    ]\n  },\n  \"businessUnitId\": \"<string>\",\n  \"description\": \"<string>\",\n  \"reportIdsToAdd\": [\n    \"<string>\"\n  ]\n}")
  .asString();

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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"permissions\": {\n    \"specificPermissions\": [\n      {\n        \"grants\": [\n          {\n            \"granteeId\": \"<string>\"\n          }\n        ]\n      }\n    ]\n  },\n  \"businessUnitId\": \"<string>\",\n  \"description\": \"<string>\",\n  \"reportIdsToAdd\": [\n    \"<string>\"\n  ]\n}"

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

{
  "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>"
      }
    }
  ]
}

{
  "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.

Body

application/json

name

string

required

The name of the new dashboard.

permissions

object

required

Show child attributes

businessUnitId

string

The ID of the business unit to associate the new dashboard with. Optional, the account's default is used by default.

description

string

A description of the new dashboard. Optional.

reportIdsToAdd

string[]

Array of IDs of reports that should be added to the dashboard after creation. Optional.

Response

successful operation

archived

boolean

required

Whether the dashboard is archived.

businessUnitId

string

required

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

createdAt

string<date-time>

required

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

string

required

The ID of the dashboard.

name

string

required

The name of the dashboard.

updatedAt

string<date-time>

required

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

archivedAt

string<date-time>

If the dashboard is archived, the date and time when the dashboard was archived, in ISO 8601 format. Absent if the dashboard is not archived.

createdByUserId

string

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

description

string

A description of the dashboard. May be absent.

lastViewedAt

string<date-time>

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

lastViewedByUserId

string

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

ownerUserId

string

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

permissions

object

Show child attributes