curl --request POST \
--url https://api.arize.com/v2/dashboards \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"space_id": "U3BhY2U6MTIzNDU=",
"name": "Production Overview",
"timezone": "America/Los_Angeles",
"start_time": "2024-01-01T00:00:00Z",
"end_time": "2024-01-08T00:00:00Z",
"time_series_data_granularity": "hour",
"time_range_key": "7d"
}
'import requests
url = "https://api.arize.com/v2/dashboards"
payload = {
"space_id": "U3BhY2U6MTIzNDU=",
"name": "Production Overview",
"timezone": "America/Los_Angeles",
"start_time": "2024-01-01T00:00:00Z",
"end_time": "2024-01-08T00:00:00Z",
"time_series_data_granularity": "hour",
"time_range_key": "7d"
}
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({
space_id: 'U3BhY2U6MTIzNDU=',
name: 'Production Overview',
timezone: 'America/Los_Angeles',
start_time: '2024-01-01T00:00:00Z',
end_time: '2024-01-08T00:00:00Z',
time_series_data_granularity: 'hour',
time_range_key: '7d'
})
};
fetch('https://api.arize.com/v2/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.arize.com/v2/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([
'space_id' => 'U3BhY2U6MTIzNDU=',
'name' => 'Production Overview',
'timezone' => 'America/Los_Angeles',
'start_time' => '2024-01-01T00:00:00Z',
'end_time' => '2024-01-08T00:00:00Z',
'time_series_data_granularity' => 'hour',
'time_range_key' => '7d'
]),
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.arize.com/v2/dashboards"
payload := strings.NewReader("{\n \"space_id\": \"U3BhY2U6MTIzNDU=\",\n \"name\": \"Production Overview\",\n \"timezone\": \"America/Los_Angeles\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-01-08T00:00:00Z\",\n \"time_series_data_granularity\": \"hour\",\n \"time_range_key\": \"7d\"\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.arize.com/v2/dashboards")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"space_id\": \"U3BhY2U6MTIzNDU=\",\n \"name\": \"Production Overview\",\n \"timezone\": \"America/Los_Angeles\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-01-08T00:00:00Z\",\n \"time_series_data_granularity\": \"hour\",\n \"time_range_key\": \"7d\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arize.com/v2/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 \"space_id\": \"U3BhY2U6MTIzNDU=\",\n \"name\": \"Production Overview\",\n \"timezone\": \"America/Los_Angeles\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-01-08T00:00:00Z\",\n \"time_series_data_granularity\": \"hour\",\n \"time_range_key\": \"7d\"\n}"
response = http.request(request)
puts response.read_body{
"id": "RGFzaGJvYXJkOjEyMzQ1",
"space_id": "U3BhY2U6MTIzNDU=",
"name": "Production Overview",
"status": "ACTIVE",
"timezone": "America/Los_Angeles",
"start_time": null,
"end_time": null,
"time_series_data_granularity": "hour",
"time_range_key": "7d",
"created_at": "2024-01-01T12:00:00Z",
"creator_user_id": "VXNlcjoxMjM0NQ==",
"tags": [],
"widgets": []
}{
"status": 400,
"title": "Invalid request parameters",
"detail": "The 'name' field is required and must be a non-empty string.",
"instance": "/resource",
"type": "https://arize.com/docs/ax/rest-reference/errors#invalid-request"
}{
"status": 401,
"title": "Authentication required",
"detail": "You must be authenticated to access this resource.",
"instance": "/resource",
"type": "https://arize.com/docs/ax/rest-reference/errors#authentication-required"
}{
"status": 403,
"title": "Access forbidden",
"detail": "You do not have permission to access this resource.",
"instance": "/resource/12345",
"type": "https://arize.com/docs/ax/rest-reference/errors#access-forbidden"
}{
"status": 404,
"title": "Resource not found",
"detail": "The requested resource with ID '12345' was not found.",
"instance": "/resource/12345",
"type": "https://arize.com/docs/ax/rest-reference/errors#resource-not-found"
}{
"status": 422,
"title": "Unprocessable Entity",
"detail": "One or more fields failed validation.",
"instance": "/resource/12345",
"type": "https://arize.com/docs/ax/rest-reference/errors#unprocessable-entity"
}{
"status": 429,
"title": "Rate limit exceeded",
"detail": "You have exceeded the allowed number of requests. Please try again later.",
"instance": "/resource",
"type": "https://arize.com/docs/ax/rest-reference/errors#rate-limit-exceeded"
}Create a dashboard
Create an empty dashboard in a space. The caller must have permission to create dashboards in the target space. New dashboards start active, and widgets are added separately.
curl --request POST \
--url https://api.arize.com/v2/dashboards \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"space_id": "U3BhY2U6MTIzNDU=",
"name": "Production Overview",
"timezone": "America/Los_Angeles",
"start_time": "2024-01-01T00:00:00Z",
"end_time": "2024-01-08T00:00:00Z",
"time_series_data_granularity": "hour",
"time_range_key": "7d"
}
'import requests
url = "https://api.arize.com/v2/dashboards"
payload = {
"space_id": "U3BhY2U6MTIzNDU=",
"name": "Production Overview",
"timezone": "America/Los_Angeles",
"start_time": "2024-01-01T00:00:00Z",
"end_time": "2024-01-08T00:00:00Z",
"time_series_data_granularity": "hour",
"time_range_key": "7d"
}
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({
space_id: 'U3BhY2U6MTIzNDU=',
name: 'Production Overview',
timezone: 'America/Los_Angeles',
start_time: '2024-01-01T00:00:00Z',
end_time: '2024-01-08T00:00:00Z',
time_series_data_granularity: 'hour',
time_range_key: '7d'
})
};
fetch('https://api.arize.com/v2/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.arize.com/v2/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([
'space_id' => 'U3BhY2U6MTIzNDU=',
'name' => 'Production Overview',
'timezone' => 'America/Los_Angeles',
'start_time' => '2024-01-01T00:00:00Z',
'end_time' => '2024-01-08T00:00:00Z',
'time_series_data_granularity' => 'hour',
'time_range_key' => '7d'
]),
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.arize.com/v2/dashboards"
payload := strings.NewReader("{\n \"space_id\": \"U3BhY2U6MTIzNDU=\",\n \"name\": \"Production Overview\",\n \"timezone\": \"America/Los_Angeles\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-01-08T00:00:00Z\",\n \"time_series_data_granularity\": \"hour\",\n \"time_range_key\": \"7d\"\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.arize.com/v2/dashboards")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"space_id\": \"U3BhY2U6MTIzNDU=\",\n \"name\": \"Production Overview\",\n \"timezone\": \"America/Los_Angeles\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-01-08T00:00:00Z\",\n \"time_series_data_granularity\": \"hour\",\n \"time_range_key\": \"7d\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arize.com/v2/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 \"space_id\": \"U3BhY2U6MTIzNDU=\",\n \"name\": \"Production Overview\",\n \"timezone\": \"America/Los_Angeles\",\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"end_time\": \"2024-01-08T00:00:00Z\",\n \"time_series_data_granularity\": \"hour\",\n \"time_range_key\": \"7d\"\n}"
response = http.request(request)
puts response.read_body{
"id": "RGFzaGJvYXJkOjEyMzQ1",
"space_id": "U3BhY2U6MTIzNDU=",
"name": "Production Overview",
"status": "ACTIVE",
"timezone": "America/Los_Angeles",
"start_time": null,
"end_time": null,
"time_series_data_granularity": "hour",
"time_range_key": "7d",
"created_at": "2024-01-01T12:00:00Z",
"creator_user_id": "VXNlcjoxMjM0NQ==",
"tags": [],
"widgets": []
}{
"status": 400,
"title": "Invalid request parameters",
"detail": "The 'name' field is required and must be a non-empty string.",
"instance": "/resource",
"type": "https://arize.com/docs/ax/rest-reference/errors#invalid-request"
}{
"status": 401,
"title": "Authentication required",
"detail": "You must be authenticated to access this resource.",
"instance": "/resource",
"type": "https://arize.com/docs/ax/rest-reference/errors#authentication-required"
}{
"status": 403,
"title": "Access forbidden",
"detail": "You do not have permission to access this resource.",
"instance": "/resource/12345",
"type": "https://arize.com/docs/ax/rest-reference/errors#access-forbidden"
}{
"status": 404,
"title": "Resource not found",
"detail": "The requested resource with ID '12345' was not found.",
"instance": "/resource/12345",
"type": "https://arize.com/docs/ax/rest-reference/errors#resource-not-found"
}{
"status": 422,
"title": "Unprocessable Entity",
"detail": "One or more fields failed validation.",
"instance": "/resource/12345",
"type": "https://arize.com/docs/ax/rest-reference/errors#unprocessable-entity"
}{
"status": 429,
"title": "Rate limit exceeded",
"detail": "You have exceeded the allowed number of requests. Please try again later.",
"instance": "/resource",
"type": "https://arize.com/docs/ax/rest-reference/errors#rate-limit-exceeded"
}Authorizations
Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format
Service accounts may instead present an access token issued by an external identity provider (Microsoft Entra ID) when the account admin has configured that provider. Send it in the same header: Authorization: Bearer <access-token>.
Body
Body containing dashboard creation parameters
Response
Dashboard created
A dashboard groups charts, statistics, text, and tables to help you monitor and analyze your application data. The response includes published widgets only.
Was this page helpful?