Every API here is available over the APIs.io API and to AI agents over MCP.
{
"openapi": "3.0.1",
"info": {
"title": "Fenergo Nebula Dashboards Query (PENDING DEPRECATION)",
"description": "!!! IMPORTANT NOTICE: \nThis API is pending deprecation and will be removed on 28.02.2026. For more information visit: https://docs.fenergox.com/notice-of-change/2025/07/22/legacy-dashboards-deprecation \n\nDashboards Query API is part of FenX eco-system to manage Dashboards. All the operations require valid access token obtained from Identity service.",
"version": "1.0.0"
},
"servers": [
{
"url": "/dashboardsquery"
}
],
"paths": {
"/api/journey-dashboard": {
"post": {
"tags": [
"JourneyDashboard"
],
"summary": "Get in progress journeys assigned to the specified team.",
"description": "<br /><br /><b>Required permissions:</b><br />Following permissions are required: TeamDashboardAccess",
"operationId": "GetTeamJourneyDashboard",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "List of team IDs",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringListServiceRequest"
}
}
}
},
"responses": {
"413": {
"description": "Payload Too Large",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "The amount of data requested is too large. Please request smaller data set.",
"type": "Error",
"errorCode": "PAYLOAD_TOO_LARGE"
}
]
}
}
}
},
"200": {
"description": "Success. Journey dashboard for specified criteria is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyDashboardDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal server error"
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
}
},
"deprecated": true
}
},
"/api/journey-dashboard/lite": {
"post": {
"tags": [
"JourneyDashboard"
],
"summary": "Get in progress journeys assigned to the specified team without tasks.",
"description": "<br /><br /><b>Required permissions:</b><br />Following permissions are required: TeamDashboardAccess",
"operationId": "GetTeamJourneyDashboardLite",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "List of team IDs",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringListServiceRequest"
}
}
}
},
"responses": {
"413": {
"description": "Payload Too Large",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "The amount of data requested is too large. Please request smaller data set.",
"type": "Error",
"errorCode": "PAYLOAD_TOO_LARGE"
}
]
}
}
}
},
"200": {
"description": "Success. Journey dashboard for specified criteria is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyDashboardDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal server error"
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
}
},
"deprecated": true
}
},
"/api/journey-dashboard/preview": {
"post": {
"tags": [
"JourneyDashboard"
],
"summary": "Get in progress journeys assigned to the specified team without tasks.",
"description": "<br /><br /><b>Required permissions:</b><br />Following permissions are required: TeamDashboardAccess",
"operationId": "GetTeamJourneyDashboardPreview",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "List of team IDs",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringListServiceRequest"
}
}
}
},
"responses": {
"413": {
"description": "Payload Too Large",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "The amount of data requested is too large. Please request smaller data set.",
"type": "Error",
"errorCode": "PAYLOAD_TOO_LARGE"
}
]
}
}
}
},
"200": {
"description": "Success. Journey dashboard for specified criteria is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyDashboardDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal server error"
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
}
}
}
},
"/api/journey-dashboard/journeys": {
"post": {
"tags": [
"JourneyDashboard"
],
"summary": "Get in progress journeys assigned to the specified team without tasks.",
"description": "<br /><br /><b>Required permissions:</b><br />Following permissions are required: TeamDashboardAccess",
"operationId": "GetTeamJourneys",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "List of team IDs",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringListServiceRequest"
}
}
}
},
"responses": {
"413": {
"description": "Payload Too Large",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "The amount of data requested is too large. Please request smaller data set.",
"type": "Error",
"errorCode": "PAYLOAD_TOO_LARGE"
}
]
}
}
}
},
"200": {
"description": "Success. Journey dashboard for specified criteria is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyDashboardDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal server error"
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
}
}
}
},
"/api/journey-dashboard/journeys/entity/{entityId}": {
"get": {
"tags": [
"JourneyDashboard"
],
"summary": "Get all journeys for a given entity",
"description": "<br /><br /><b>Required permissions:</b><br />Following permissions are required: JourneyAccess",
"operationId": "GetEntityJourneys",
"parameters": [
{
"name": "entityId",
"in": "path",
"description": "The UiD of the entity",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"413": {
"description": "Payload Too Large",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "The amount of data requested is too large. Please request smaller data set.",
"type": "Error",
"errorCode": "PAYLOAD_TOO_LARGE"
}
]
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyDashboardDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
}
}
}
},
"/api/journey-dashboard/tasks/{journeyId}": {
"post": {
"tags": [
"JourneyDashboard"
],
"summary": "Get tasks for given journey",
"description": "<br /><br /><b>Required permissions:</b><br />At least one of the following permissions is required: TeamDashboardAccess, JourneyAccess",
"operationId": "GetJourneyTasks",
"parameters": [
{
"name": "journeyId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "List of team IDs",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringListServiceRequest"
}
}
}
},
"responses": {
"413": {
"description": "Payload Too Large",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "The amount of data requested is too large. Please request smaller data set.",
"type": "Error",
"errorCode": "PAYLOAD_TOO_LARGE"
}
]
}
}
}
},
"200": {
"description": "Success. Tasks for specified journey are returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyTaskDtoListServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal server error"
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
}
}
}
},
"/api/journey-dashboard/journeyMilestonesTasks/{journeyId}": {
"post": {
"tags": [
"JourneyDashboard"
],
"summary": "Get journey milestones with tasks for given journey",
"description": "<br /><br /><b>Required permissions:</b><br />Following permissions are required: TeamDashboardAccess",
"operationId": "getJourneyMilestonesTasks",
"parameters": [
{
"name": "journeyId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "List of team IDs",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringListServiceRequest"
}
}
}
},
"responses": {
"413": {
"description": "Payload Too Large",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "The amount of data requested is too large. Please request smaller data set.",
"type": "Error",
"errorCode": "PAYLOAD_TOO_LARGE"
}
]
}
}
}
},
"200": {
"description": "Success. Tasks for specified journey are returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyMilestonesTasksDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal server error"
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
}
}
}
},
"/api/journey-stats": {
"post": {
"tags": [
"JourneyStats"
],
"summary": "Get journey stats like number of journeys completed or average journey time.",
"description": "<br /><br /><b>Required permissions:</b><br />Following permissions are required: TeamDashboardAccess",
"operationId": "GetJourneyStatsDashboard",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "Request object that contains a list of teams and date range for which the data is requested. Available range values: Daily, RollingSeven, RollingThirty",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyStatsDashboardRequestDtoServiceRequest"
}
}
}
},
"responses": {
"413": {
"description": "Payload Too Large",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "The amount of data requested is too large. Please request smaller data set.",
"type": "Error",
"errorCode": "PAYLOAD_TOO_LARGE"
}
]
}
}
}
},
"200": {
"description": "Success. Stats dashboard for specified criteria is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyStatsDashboardResponseDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal server error"
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
}
}
}
},
"/api/task-queue/{userId}": {
"get": {
"tags": [
"TaskQueueDashboard"
],
"summary": "Get tasks assigned to the specified user.",
"description": "<br /><br /><b>Required permissions:</b><br />At least one of the following permissions is required: TeamDashboardAccess, TaskDashboardAccess",
"operationId": "GetUserTasksDashboard",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"413": {
"description": "Payload Too Large",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "The amount of data requested is too large. Please request smaller data set.",
"type": "Error",
"errorCode": "PAYLOAD_TOO_LARGE"
}
]
}
}
}
},
"200": {
"description": "Success. Journey dashboard for specified criteria is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskQueueDtoListServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal server error"
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
}
}
}
},
"/api/task-queue/favourites/{userId}": {
"get": {
"tags": [
"TaskQueueDashboard"
],
"summary": "Get favourite tasks assigned to the specified user.",
"description": "<br /><br /><b>Required permissions:</b><br />Following permi
# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fenergo/refs/heads/main/openapi/fenergo-dashboardsquery-v1-0-0-openapi.json