Dashboard

Create Dashboard

Endpoint to create a new Dashboard

post/dashboard

Request

Request body

Example request

{
  "data": {
    "projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "name": "Example Text",
    "dashboardViewConfig": {
      "key": "value",
      "nested": {
        "data": 123
      }
    }
  }
}

Response

Created successfully

Example response

{
  "data": {
    "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "project": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "name": "Example Text",
    "slug": "example-slug",
    "description": "This is an example of longer text content that provides detailed information.",
    "createdByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "deletedByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "deletedByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "isArchived": true,
    "archivedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "archivedByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "archivedByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "labels": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "dashboardViewConfig": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "pageTitle": "Example Text",
    "pageDescription": "This is an example of longer text content that provides detailed information.",
    "logoFile": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "logoFileId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "darkThemeLogoFile": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "darkThemeLogoFileId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "faviconFile": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "faviconFileId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "theme": "Example Text",
    "isPublicDashboard": true,
    "enableMasterPassword": true,
    "masterPassword": "hashed_value_here",
    "ipWhitelist": "This is an example of longer text content that provides detailed information."
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.