Wexa AI
  1. Dashboard
Wexa AI
  • Wexa AI
  • Use Cases and Workflows
  • API Reference
  • Troubleshooting Guide
  • Onboarding
    • Getting Started with Wexa
    • Hire your AI Coworker
  • AI Coworker Creation
    • Create your First AI Coworker
    • Process Flows
    • Creating your First Agent
    • Schedule a Process Flow
    • Executing a Process Flow
    • Settings - Input Form
    • History
  • Tables
    • Intro to Tables
    • Adding records to Tables
    • Table Triggers
  • Knowledge Base
    • Intro to Knowledge Base
  • Connectors and MCP Servers
    • Adding a New Connector
    • Adding an MCP Server
    • Setting up Connectors Triggers
  • API Endpoints
    • Project
      • create project
      • Get all projects
      • Get project
      • update project
      • Delete project
      • Get project by proiectName
    • Agentflows
      • create agentflow
      • get agentflows
      • Get agentflow by projectId and UserId
      • get agentflow by id
      • Add skilled agent to agentflow
      • Update skilled agent
    • Connectors
      • Configure connector
      • Get config
      • Retrieve linkedin params
      • 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
    • Actions
      • Customer
        • get customer
        • Get credit history
      • create action
      • get action
    • Files
      • Connectors and MCP Servers
      • upload files
      • get files by fileid
      • get connector by fileid
      • get files by connector_id
    • Inbox
      • Create inbox
      • Update inbox at runtime
      • Update anamoly detection inbox
      • Update Preview Inbox
      • get inbox
    • Tags
      • tags
    • Dashboard
      • get dashboard
        GET
      • refresh dashboard
        POST
      • delete component in dashboard
        DELETE
    • Tasks
      • get tasks
      • get task by id
      • Pause running task
      • resume task
      • Stop task
    • Tables
      • Insert row in a table
      • Get records
      • Get record by id
      • Update record by id
      • create table
      • create database
      • get tables
      • get table names
      • delete record
      • delete a column
      • Insert column in a table
    • 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
    • Available Connectors
      • Actions
    • Execution Details
      • Execution details
    • Knowledge Base
      • File Upload
    • Create apikey
      • Generate apikey
  1. Dashboard

get dashboard

GET
https://api.wexa.ai/dashboard/{projectID}
Last modified:2025-04-25 12:07:42

Retrieve Dashboard Overview by Project ID#

Use this endpoint to retrieve a comprehensive overview of your project's dashboard in the Wexa.ai environment. The dashboard serves as your central hub for monitoring and managing your automation workflows, providing insights into key metrics, workflow executions, and easy access to all platform functionalities.

Request

Path Params

Header Params

Responses

🟢200get dashboard
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.wexa.ai/dashboard/' \
--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": []
                },
                {
                    "status": "ready",
                    "data": []
                },
                {
                    "status": "failed",
                    "data": []
                },
                {
                    "status": "paused",
                    "data": []
                }
            ]
        }
    ],
    "description": "Drag and drop widgets to customize your dashboard",
    "coworker_id": null
}
Modified at 2025-04-25 12:07:42
Previous
tags
Next
refresh dashboard