RunReveal

DashboardLayoutCreate handles creating a new dashboard layout using RPC framework

DashboardLayoutCreate handles creating a new dashboard layout using RPC framework

POST
/layouts/create

Request Body

application/jsonRequired

displayNamestring

namestring

panelsarray<object>

curl -X POST "https://api.runreveal.com/layouts/create" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "string",
    "name": "string",
    "panels": [
      {
        "graphId": "string",
        "position": 0,
        "title": "string",
        "width": "string"
      }
    ]
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "createdAt": {},
    "createdBy": "string",
    "displayName": "string",
    "id": "string",
    "name": "string",
    "panels": [
      {
        "createdAt": {},
        "graph": {
          "createdAt": {},
          "displayName": "string",
          "fill": true,
          "id": "string",
          "latitudeColumn": "string",
          "longitudeColumn": "string",
          "name": "string",
          "query": "string",
          "stack": "string",
          "stackColumn": "string",
          "type": "string",
          "updatedAt": {},
          "workspaceID": "string",
          "xAxisColumnName": "string",
          "xTitle": "string",
          "yAxisColumnName": "string",
          "yTitle": "string"
        },
        "graphId": "string",
        "id": "string",
        "layoutId": "string",
        "position": 0,
        "title": "string",
        "updatedAt": {},
        "width": "string"
      }
    ],
    "updatedAt": {},
    "workspaceID": "string"
  },
  "success": true
}

DashboardLayoutDelete handles deleting a dashboard layout using RPC framework

DashboardLayoutDelete handles deleting a dashboard layout using RPC framework

POST
/layouts/delete

Request Body

application/jsonRequired

idstring

curl -X POST "https://api.runreveal.com/layouts/delete" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {},
  "success": true
}

DashboardLayoutGet handles retrieving a dashboard layout by ID using RPC framework

DashboardLayoutGet handles retrieving a dashboard layout by ID using RPC framework

GET
/layouts/get
curl -X GET "https://api.runreveal.com/layouts/get?id=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "createdAt": {},
    "createdBy": "string",
    "displayName": "string",
    "id": "string",
    "name": "string",
    "panels": [
      {
        "createdAt": {},
        "graph": {
          "createdAt": {},
          "displayName": "string",
          "fill": true,
          "id": "string",
          "latitudeColumn": "string",
          "longitudeColumn": "string",
          "name": "string",
          "query": "string",
          "stack": "string",
          "stackColumn": "string",
          "type": "string",
          "updatedAt": {},
          "workspaceID": "string",
          "xAxisColumnName": "string",
          "xTitle": "string",
          "yAxisColumnName": "string",
          "yTitle": "string"
        },
        "graphId": "string",
        "id": "string",
        "layoutId": "string",
        "position": 0,
        "title": "string",
        "updatedAt": {},
        "width": "string"
      }
    ],
    "updatedAt": {},
    "workspaceID": "string"
  },
  "success": true
}

DashboardLayoutList handles listing all dashboard layouts for a workspace using RPC framework

DashboardLayoutList handles listing all dashboard layouts for a workspace using RPC framework

GET
/layouts/list

Query Parameters

searchstring

curl -X GET "https://api.runreveal.com/layouts/list?search=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": [
    {
      "createdAt": {},
      "createdBy": "string",
      "displayName": "string",
      "id": "string",
      "name": "string",
      "panels": [
        {
          "createdAt": {},
          "graph": {
            "createdAt": {},
            "displayName": "string",
            "fill": true,
            "id": "string",
            "latitudeColumn": "string",
            "longitudeColumn": "string",
            "name": "string",
            "query": "string",
            "stack": "string",
            "stackColumn": "string",
            "type": "string",
            "updatedAt": {},
            "workspaceID": "string",
            "xAxisColumnName": "string",
            "xTitle": "string",
            "yAxisColumnName": "string",
            "yTitle": "string"
          },
          "graphId": "string",
          "id": "string",
          "layoutId": "string",
          "position": 0,
          "title": "string",
          "updatedAt": {},
          "width": "string"
        }
      ],
      "updatedAt": {},
      "workspaceID": "string"
    }
  ],
  "success": true
}

DashboardLayoutUpdate handles updating an existing dashboard layout using RPC framework

DashboardLayoutUpdate handles updating an existing dashboard layout using RPC framework

POST
/layouts/update

Request Body

application/jsonRequired

displayNamestring

idstring

namestring

panelsarray<object>

curl -X POST "https://api.runreveal.com/layouts/update" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "string",
    "id": "string",
    "name": "string",
    "panels": [
      {
        "graphId": "string",
        "position": 0,
        "title": "string",
        "width": "string"
      }
    ]
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "createdAt": {},
    "createdBy": "string",
    "displayName": "string",
    "id": "string",
    "name": "string",
    "panels": [
      {
        "createdAt": {},
        "graph": {
          "createdAt": {},
          "displayName": "string",
          "fill": true,
          "id": "string",
          "latitudeColumn": "string",
          "longitudeColumn": "string",
          "name": "string",
          "query": "string",
          "stack": "string",
          "stackColumn": "string",
          "type": "string",
          "updatedAt": {},
          "workspaceID": "string",
          "xAxisColumnName": "string",
          "xTitle": "string",
          "yAxisColumnName": "string",
          "yTitle": "string"
        },
        "graphId": "string",
        "id": "string",
        "layoutId": "string",
        "position": 0,
        "title": "string",
        "updatedAt": {},
        "width": "string"
      }
    ],
    "updatedAt": {},
    "workspaceID": "string"
  },
  "success": true
}