Wexa AI
  1. Dashboard
Wexa AI
  • Wexa AI
  • Getting Started with Wexa AI
  • Use Cases and Workflows
  • API Reference
  • Tutorials
  • Troubleshooting Guide
  • API Endpoints
    • Project
      • create project
      • Get all projects
      • Get project
      • update project
      • Delete project
    • Agentflows
      • create agentflow
      • get agentflows
      • Get agentflow by projectId and UserId
      • get agentflow by id
      • Add skilled agent to agentflow
      • Update skilled agent
    • Connectors
      • get connectors by projectid
      • get connector by Id
      • Delete a connector
      • connector update status
      • get all available trigger actions
    • Skills
      • create skill
      • get skills
      • get skills by category'
      • get skills by id
      • skills by name
    • Executeflow
      • create executeflow
      • get executions
      • execute agentflow
      • pause executeflow
      • resume execution
      • cancel executeflow
      • get execution by execution id
      • get execution details for monitoring
    • Customer
      • get customer
      • Get credit history
    • Actions
      • create action
      • get action
    • Files
      • upload files
      • get files by fileid
      • get connector by fileid
      • get files by connector_id
    • Inbox
      • get inbox
    • Tags
      • tags
    • Tasks
      • get tasks
      • get task by id
      • Pause running task
      • resume task
      • Stop task
    • Tables
      • create table
      • create database
      • get tables
      • get records list
      • get table names
      • delete record
      • delete a column
    • Dashboard
      • get dashboard
        GET
      • refresh dashboard
        POST
      • delete component in dashboard
        DELETE
    • Settings
      • get settings
    • Marketplace
      • get all connectors
      • get marketplace coworkers
      • get marketplace coworker by id
    • Coworker schedules
      • get schedules
      • create coworker schedule
      • get schedule coworker by its id
      • update schedule by its id
      • delete schedule by its id
    • Analytics
      • Get analytics
    • Marketplace coworkers
      • hire a coworker
      • check marketplace coworker update
    • Project member
      • project_member
  1. Dashboard

refresh dashboard

POST
https://api.wexa.ai/dashboard/refresh/{projectID}
Last modified:2025-04-25 12:09:02

Refresh Project Dashboard#

Use this endpoint to refresh the dashboard for a specific project within your Wexa.ai environment. Refreshing the dashboard ensures that all metrics, visualizations, and data representations are up-to-date, reflecting the latest status of your automation workflows and resource utilization.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.wexa.ai/dashboard/refresh/' \
--header 'x-api-key: {{x-api-key}}'
Response Response Example
{
  "_id": "67fdea9c0de4fb70696a0b0c",
  "name": "Pulse",
  "position": [
    {
      "tab_id": "67e1367cf4f366b0cff3c3d0",
      "x": 0,
      "y": 0,
      "h": 25,
      "w": 7,
      "i": "67e1367cf4f366b0cff3c3d5",
      "minW": 4,
      "minH": 4
    }
  ],
  "tabs": [
    {
      "name": "Overview",
      "id": "67e1367cf4f366b0cff3c3d0"
    },
    {
      "name": "Analytics",
      "id": "67e1367cf4f366b0cff3c3d1"
    },
    {
      "name": "Reports",
      "id": "67e1367cf4f366b0cff3c3d2"
    }
  ],
  "project_id": "67fdea40aac77be632954f13",
  "components": [
    {
      "tab_id": "67e1367cf4f366b0cff3c3d0",
      "component_type": "taskManager",
      "user_query": null,
      "title": "My Tasks",
      "subTitle": "",
      "component_id": "67e1367cf4f366b0cff3c3d5",
      "resource": "default",
      "table_id": null,
      "process_buttons": [],
      "button_title": null,
      "coworker_id": null,
      "column_keys": [],
      "columns": [],
      "icon": "clipboard-list",
      "query": {
        "aggregation_code": [
          {
            "$match": {
              "projectID": "67fdea40aac77be632954f13"
            }
          },
          {
            "$facet": {
              "running": [
                {
                  "$match": {
                    "status": "running"
                  }
                },
                {
                  "$project": {
                    "_id": 1,
                    "name": 1,
                    "created_at": 1,
                    "status": 1
                  }
                }
              ],
              "completed": [
                {
                  "$match": {
                    "status": "completed"
                  }
                },
                {
                  "$project": {
                    "_id": 1,
                    "name": 1,
                    "created_at": 1,
                    "status": 1
                  }
                }
              ],
              "ready": [
                {
                  "$match": {
                    "status": "ready"
                  }
                },
                {
                  "$project": {
                    "_id": 1,
                    "name": 1,
                    "created_at": 1,
                    "status": 1
                  }
                }
              ],
              "failed": [
                {
                  "$match": {
                    "status": "failed"
                  }
                },
                {
                  "$project": {
                    "_id": 1,
                    "name": 1,
                    "created_at": 1,
                    "status": 1
                  }
                }
              ],
              "paused": [
                {
                  "$match": {
                    "status": "paused"
                  }
                },
                {
                  "$project": {
                    "_id": 1,
                    "name": 1,
                    "created_at": 1,
                    "status": 1
                  }
                }
              ]
            }
          }
        ]
      },
      "data": [
        {
          "status": "running",
          "data": []
        },
        {
          "status": "completed",
          "data": [
            {
              "_id": "6805d8547d3775bffdb87551",
              "created_at": 1745213524.773548,
              "status": "completed",
              "name": "new platform"
            },
            {
              "_id": "6805e3a97d3775bffdb87608",
              "created_at": 1745216425.41182,
              "status": "completed",
              "name": "new platform"
            },
            {
              "_id": "6805e44e7d3775bffdb8760a",
              "created_at": 1745216590.773335,
              "status": "completed",
              "name": "new platform"
            },
            {
              "_id": "6805e5577d3775bffdb8760c",
              "created_at": 1745216855.384694,
              "status": "completed",
              "name": "new platform"
            },
            {
              "_id": "6805e6ca7d3775bffdb8760e",
              "created_at": 1745217226.636342,
              "status": "completed",
              "name": "new platform"
            },
            {
              "_id": "6805e8477d3775bffdb87610",
              "created_at": 1745217607.232776,
              "status": "completed",
              "name": "new platform"
            },
            {
              "_id": "6805f401064a778a5f18f846",
              "created_at": 1745220609.002351,
              "status": "completed",
              "name": "new platform"
            },
            {
              "_id": "68060114064a778a5f18f84f",
              "created_at": 1745223956.857456,
              "status": "completed",
              "name": "new platform"
            },
            {
              "_id": "6806062e064a778a5f18f9d4",
              "created_at": 1745225262.35144,
              "status": "completed",
              "name": "new platform"
            },
            {
              "_id": "68062352fc2e1fb8597c775a",
              "created_at": 1745232722.189382,
              "status": "completed",
              "name": "new platform"
            }
          ]
        },
        {
          "status": "ready",
          "data": [
            {
              "_id": "6805f3f6064a778a5f18f844",
              "created_at": 1745220598.837637,
              "status": "ready",
              "name": "new platform"
            },
            {
              "_id": "6806055b064a778a5f18f9ca",
              "created_at": 1745225051.359286,
              "status": "ready",
              "name": "new platform"
            },
            {
              "_id": "68060627064a778a5f18f9d0",
              "created_at": 1745225255.138971,
              "status": "ready",
              "name": "new platform"
            }
          ]
        },
        {
          "status": "failed",
          "data": []
        },
        {
          "status": "paused",
          "data": []
        }
      ]
    }
  ],
  "description": "Drag and drop widgets to customize your dashboard",
  "coworker_id": null
}

Request

Path Params
projectID
string 
required
Header Params
x-api-key
string 
required
Example:
{{x-api-key}}

Responses

🟢200refresh dashboard
application/json
Body
_id
string 
required
name
string 
required
position
array [object {8}] 
required
tab_id
string 
optional
x
integer 
optional
y
integer 
optional
h
integer 
optional
w
integer 
optional
i
string 
optional
minW
integer 
optional
minH
integer 
optional
tabs
array [object {2}] 
required
name
string 
required
id
string 
required
project_id
string 
required
components
array [object {16}] 
required
tab_id
string 
optional
component_type
string 
optional
user_query
null 
optional
title
string 
optional
subTitle
string 
optional
component_id
string 
optional
resource
string 
optional
table_id
null 
optional
process_buttons
array
optional
button_title
null 
optional
coworker_id
null 
optional
column_keys
array
optional
columns
array
optional
icon
string 
optional
query
object 
optional
data
array [object {2}] 
optional
description
string 
required
coworker_id
null 
required
Modified at 2025-04-25 12:09:02
Previous
get dashboard
Next
delete component in dashboard