Criar painel

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

Painéis

Create dashboard

Cria um novo painel. Relatórios existentes podem ser anexados opcionalmente ao painel no momento da criação; os widgets de relatório serão anexados sequencialmente.

A ação de anexar relatórios ao painel é feita da melhor maneira possível, e é possível que alguns ou todos os relatórios não sejam anexados. O painel ainda será criado, e nenhum erro será retornado. O solicitante deve verificar o campo widgets no objeto de resposta para ver quais relatórios foram anexados com sucesso.

POST

analytics

reporting

2027-03-beta

dashboards

Criar painel

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

Autorizações

Authorization

string

header

obrigatório

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

Corpo

application/json

name

string

obrigatório

O nome do novo painel.

permissions

object

obrigatório

Show child attributes

businessUnitId

string

O ID da unidade de negócios à qual o novo painel será associado. Opcional; o padrão da conta é usado por padrão.

description

string

Uma descrição do novo painel. Opcional.

reportIdsToAdd

string[]

Matriz de IDs de relatórios que devem ser adicionados ao painel após a criação. Opcional.

Resposta

successful operation

archived

boolean

obrigatório

Se o painel foi arquivado.

businessUnitId

string

obrigatório

O ID da unidade de negócios à qual o painel está associado.

createdAt

string<date-time>

obrigatório

A data e a hora em que o painel foi criado, no formato ISO 8601.

string

obrigatório

O ID do painel.

name

string

obrigatório

O nome do painel.

updatedAt

string<date-time>

obrigatório

Data e hora da última atualização do painel, no formato ISO 8601.

archivedAt

string<date-time>

Se o painel foi arquivado, a data e a hora em que isso aconteceu, no formato ISO 8601. Ausente se o painel não foi arquivado.

createdByUserId

string

ID do usuário que criou o painel. Pode estar ausente.

description

string

Uma descrição do painel. Pode estar ausente.

lastViewedAt

string<date-time>

A data e a hora em que o painel foi visualizado pela última vez, no formato ISO 8601. Ausente se ainda não tiver sido visualizado.

lastViewedByUserId

string

O ID do usuário que visualizou o painel pela última vez. Ausente se ainda não tiver sido visualizado.

ownerUserId

string

O ID do usuário que possui o painel. Ausente se o painel não tiver proprietário no momento.

permissions

object

Show child attributes

Automação

CRM

Marketing

Reuniões

Consultando dados

Relatórios

Receita

Create dashboard

Autorizações

Corpo

Resposta