Skip to main content
POST
/
api
/
v1
/
external
/
dashboards
Create Dashboard
curl --request POST \
  --url https://prod.dataapi.papermap.ai/api/v1/external/dashboards \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Key-ID: <x-api-key-id>' \
  --header 'X-Signature: <x-signature>' \
  --header 'X-Valid-Until: <x-valid-until>' \
  --header 'X-Workspace-ID: <x-workspace-id>' \
  --data '
{
  "workspace_id": "<string>",
  "title": "<string>",
  "description": "<string>"
}
'
{
  "message": "<string>",
  "success": true,
  "data": {
    "created_by": "<string>",
    "modified_by": "<string>",
    "deleted_by": "<string>",
    "dashboard_id": "<string>",
    "title": "<string>",
    "description": "<string>",
    "workspace_id": "<string>",
    "dashboard_status": "<string>",
    "meta": {},
    "configuration": {},
    "is_public": true,
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z"
  }
}

Headers

X-API-Key-ID
string
required

API Key Identifier

X-Workspace-ID
string
required

Workspace Identifier

X-Valid-Until
string
required

Validity timestamp for the request

X-Signature
string
required

Request signature for authentication

Content-Type
enum<string>
required

Specifies the content type of the request body

Available options:
application/json
Access-Control-Allow-Origin
enum<string>

CORS allow origin header

Available options:
*

Body

application/json
workspace_id
string
required

ID of the workspace

title
string
required

Title of the dashboard

description
string

Optional description of the dashboard

Response

200 - application/json

Dashboard created successfully

message
string
success
boolean
data
object