Créer un tableau de bord

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>",
        "dashboardIds": [
          "<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"
  }
}

Tableaux de bord

Create dashboard

Crée un nouveau tableau de bord. Les rapports existants peuvent être attachés au tableau de bord lors de sa création ; les widgets de rapport seront ajoutés séquentiellement.

L’attachement des rapports au tableau de bord est effectué au mieux, et il est possible que certains ou tous les rapports ne puissent pas être attachés. Le tableau de bord sera tout de même créé, et aucune erreur ne sera renvoyée. Le demandeur doit vérifier le champ « widgets » dans l’objet de réponse pour voir quels rapports ont été attachés avec succès.

POST

analytics

reporting

2027-03-beta

dashboards

Créer un tableau de bord

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>",
        "dashboardIds": [
          "<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

Autorisations

Authorization

string

header

requis

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

Corps

application/json

name

string

requis

Le nom du nouveau tableau de bord.

permissions

object

requis

Show child attributes

businessUnitId

string

L'ID de l'unité commerciale à laquelle associer le nouveau tableau de bord. Facultatif, la valeur par défaut du compte est utilisée par défaut.

description

string

Une description du nouveau tableau de bord. Facultatif.

reportIdsToAdd

string[]

Tableau des identifiants des rapports à ajouter au tableau de bord après la création. Facultatif.

Réponse

successful operation

archived

boolean

requis

Indique si le tableau de bord est archivé.

businessUnitId

string

requis

ID de l'unité commerciale à laquelle le tableau de bord est associé.

createdAt

string<date-time>

requis

La date et l'heure de création du tableau de bord, au format ISO 8601.

string

requis

L'ID du tableau de bord.

name

string

requis

Nom du tableau de bord.

updatedAt

string<date-time>

requis

La date et l'heure de la dernière mise à jour du tableau de bord, au format ISO 8601.

archivedAt

string<date-time>

Si le tableau de bord est archivé, la date et l'heure de son archivage, au format ISO 8601. Absent si le tableau de bord n'est pas archivé.

createdByUserId

string

L'ID de l'utilisateur qui a créé le tableau de bord. Peut être absent.

description

string

Description du tableau de bord. Peut être absente.

lastViewedAt

string<date-time>

La date et l'heure de la dernière consultation du tableau de bord, au format ISO 8601. Absent s'il n'a pas encore été consulté.

lastViewedByUserId

string

L'ID de l'utilisateur qui a consulté le tableau de bord en dernier. Absent s'il n'a pas encore été consulté.

ownerUserId

string

L'identifiant de l'utilisateur propriétaire du tableau de bord. Absent si le tableau de bord n'a actuellement pas de propriétaire.

permissions

object

Show child attributes

Automatisation

CRM

Marketing

Rendez-vous

Interrogation de données

Reporting

Chiffre d'affaires

Create dashboard

Autorisations

Corps

Réponse