Cloud API - Dashboards

Updated

Cloud API - Dashboards

Base URL: https://public-api.loadgen.cloud

This article documents dashboard endpoints (dashboard definitions, pages, widgets, customization, and dashboard data endpoints).

ConvertDashboard

Method: POST

Path: /api/services/app/Dashboard/ConvertDashboard

Operation ID: ApiServicesAppDashboardConvertdashboardPost

Tag: Dashboard

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: GuidEntityDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| id | string (uuid) | No | | format: uuid |

Example request body

`json

{

"id": "00000000-0000-0000-0000-000000000000"

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Dashboard/ConvertDashboard" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"id":"00000000-0000-0000-0000-000000000000"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Dashboard/ConvertDashboard"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"id": "00000000-0000-0000-0000-000000000000"

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

Copy

Method: POST

Path: /api/services/app/Dashboard/Copy

Operation ID: ApiServicesAppDashboardCopyPost

Tag: Dashboard

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreateOrEditDashboardDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| defaultParameter | string | No | | |

| id | string (uuid) | No | | format: uuid |

| isDefault | boolean | No | | |

| isMaster | boolean | No | | |

| name | string | No | | |

| parentDashboard | object(GetAllDashboardDto) | No | | |

| refreshTime | integer (int64) | No | | format: int64 |

Example request body

`json

{

"name": "string",

"isDefault": false,

"isMaster": false

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Dashboard/Copy" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"name":"string","isDefault":false,"isMaster":false}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Dashboard/Copy"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"name": "string",

"isDefault": false,

"isMaster": false

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

CreateOrEdit

Method: POST

Path: /api/services/app/Dashboard/CreateOrEdit

Operation ID: ApiServicesAppDashboardCreateoreditPost

Tag: Dashboard

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: array

Request body fields

None

Example request body

`json

[

{

"name": "string",

"isDefault": false,

"isMaster": false

}

]

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Dashboard/CreateOrEdit" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '[{"name":"string","isDefault":false,"isMaster":false}]'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Dashboard/CreateOrEdit"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

[

{

"name": "string",

"isDefault": false,

"isMaster": false

}

]

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

Delete

Method: DELETE

Path: /api/services/app/Dashboard/Delete

Operation ID: ApiServicesAppDashboardDeleteDelete

Tag: Dashboard

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Id | query | string (uuid) | No | | format: uuid |

| deleteChilds | query | boolean | No | false | |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/Dashboard/Delete?Id=00000000-0000-0000-0000-000000000000&deleteChilds=false" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Dashboard/Delete?Id=00000000-0000-0000-0000-000000000000&deleteChilds=false"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method DELETE -Uri $uri -Headers $headers

`

GetAll

Method: GET

Path: /api/services/app/Dashboard/GetAll

Operation ID: ApiServicesAppDashboardGetallGet

Tag: Dashboard

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Filter | query | string | No | | |

| ParentId | query | string (uuid) | No | | format: uuid |

| OutputType | query | enum(0 | 1 | 2) | No | | format: int32

enum: 0, 1, 2 |

| Sorting | query | string | No | | |

| SkipCount | query | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

| MaxResultCount | query | integer (int32) | No | | format: int32

min: 1

max: 2147483647 |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetAllDashboardDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

| totalCount | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"name": "string",

"creatorUserId": 0,

"isMaster": false

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Dashboard/GetAll?Filter=string&ParentId=00000000-0000-0000-0000-000000000000&OutputType=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Dashboard/GetAll?Filter=string&ParentId=00000000-0000-0000-0000-000000000000&OutputType=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetDefaultDashboard

Method: GET

Path: /api/services/app/Dashboard/GetDefaultDashboard

Operation ID: ApiServicesAppDashboardGetdefaultdashboardGet

Tag: Dashboard

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: string

Response fields

None

Example response

`json

{

"result": "string",

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Dashboard/GetDefaultDashboard" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Dashboard/GetDefaultDashboard"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetDefaultParameterValue

Method: GET

Path: /api/services/app/Dashboard/GetDefaultParameterValue

Operation ID: ApiServicesAppDashboardGetdefaultparametervalueGet

Tag: Dashboard

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Id | query | string (uuid) | No | | format: uuid |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: string

Response fields

None

Example response

`json

{

"result": "string",

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Dashboard/GetDefaultParameterValue?Id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Dashboard/GetDefaultParameterValue?Id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

SetRefreshTime

Method: POST

Path: /api/services/app/Dashboard/SetRefreshTime

Operation ID: ApiServicesAppDashboardSetrefreshtimePost

Tag: Dashboard

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: RefreshTimeDashboardDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| id | string (uuid) | No | | format: uuid |

| refreshTime | integer (int64) | No | | format: int64 |

Example request body

`json

{

"refreshTime": 0,

"id": "00000000-0000-0000-0000-000000000000"

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Dashboard/SetRefreshTime" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"refreshTime":0,"id":"00000000-0000-0000-0000-000000000000"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Dashboard/SetRefreshTime"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"refreshTime": 0,

"id": "00000000-0000-0000-0000-000000000000"

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

AddNewPage

Method: POST

Path: /api/services/app/DashboardCustomization/AddNewPage

Operation ID: ApiServicesAppDashboardcustomizationAddnewpagePost

Tag: DashboardCustomization

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: AddNewPageInput

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| application | string | No | | |

| dashboardName | string | No | | |

| name | string | No | | |

Example request body

`json

{

"dashboardName": "string",

"name": "string",

"application": "string"

}

`

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: AddNewPageOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| pageId | string | No | | |

Example response

`json

{

"result": {

"pageId": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/DashboardCustomization/AddNewPage" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"dashboardName":"string","name":"string","application":"string"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/DashboardCustomization/AddNewPage"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"dashboardName": "string",

"name": "string",

"application": "string"

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

AddWidget

Method: POST

Path: /api/services/app/DashboardCustomization/AddWidget

Operation ID: ApiServicesAppDashboardcustomizationAddwidgetPost

Tag: DashboardCustomization

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: AddWidgetInput

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| application | string | No | | |

| dashboardName | string | No | | |

| height | integer (int32) | No | | format: int32 |

| pageId | string | No | | |

| widgetId | string | No | | |

| width | integer (int32) | No | | format: int32 |

Example request body

`json

{

"widgetId": "string",

"pageId": "string",

"dashboardName": "string"

}

`

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: Widget

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| height | integer (int32) | No | | format: int32 |

| positionX | integer (int32) | No | | format: int32 |

| positionY | integer (int32) | No | | format: int32 |

| widgetId | string | No | | |

| width | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"widgetId": "string",

"height": 0,

"width": 0

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/DashboardCustomization/AddWidget" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"widgetId":"string","pageId":"string","dashboardName":"string"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/DashboardCustomization/AddWidget"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"widgetId": "string",

"pageId": "string",

"dashboardName": "string"

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

DeletePage

Method: DELETE

Path: /api/services/app/DashboardCustomization/DeletePage

Operation ID: ApiServicesAppDashboardcustomizationDeletepageDelete

Tag: DashboardCustomization

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Id | query | string | No | | |

| DashboardName | query | string | No | | |

| Application | query | string | No | | |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/DashboardCustomization/DeletePage?Id=string&DashboardName=string&Application=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/DashboardCustomization/DeletePage?Id=string&DashboardName=string&Application=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method DELETE -Uri $uri -Headers $headers

`

GetAllAvailableWidgetDefinitionsForPage

Method: GET

Path: /api/services/app/DashboardCustomization/GetAllAvailableWidgetDefinitionsForPage

Operation ID: ApiServicesAppDashboardcustomizationGetallavailablewidgetdefinitionsforpageGet

Tag: DashboardCustomization

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| DashboardName | query | string | No | | |

| Application | query | string | No | | |

| PageId | query | string | No | | |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: array

Response fields

None

Example response

`json

{

"result": [

{

"id": "string",

"name": "string",

"description": "string"

}

],

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/DashboardCustomization/GetAllAvailableWidgetDefinitionsForPage?DashboardName=string&Application=string&PageId=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/DashboardCustomization/GetAllAvailableWidgetDefinitionsForPage?DashboardName=string&Application=string&PageId=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetAllWidgetDefinitions

Method: GET

Path: /api/services/app/DashboardCustomization/GetAllWidgetDefinitions

Operation ID: ApiServicesAppDashboardcustomizationGetallwidgetdefinitionsGet

Tag: DashboardCustomization

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| DashboardName | query | string | No | | |

| Application | query | string | No | | |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: array

Response fields

None

Example response

`json

{

"result": [

{

"id": "string",

"name": "string",

"description": "string"

}

],

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/DashboardCustomization/GetAllWidgetDefinitions?DashboardName=string&Application=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/DashboardCustomization/GetAllWidgetDefinitions?DashboardName=string&Application=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetDashboardDefinition

Method: GET

Path: /api/services/app/DashboardCustomization/GetDashboardDefinition

Operation ID: ApiServicesAppDashboardcustomizationGetdashboarddefinitionGet

Tag: DashboardCustomization

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| DashboardName | query | string | No | | |

| Application | query | string | No | | |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: DashboardOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| name | string | No | | |

| widgets | array | No | | |

Example response

`json

{

"result": {

"name": "string",

"widgets": [

{

"id": "string",

"name": "string",

"description": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/DashboardCustomization/GetDashboardDefinition?DashboardName=string&Application=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/DashboardCustomization/GetDashboardDefinition?DashboardName=string&Application=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetSettingName

Method: GET

Path: /api/services/app/DashboardCustomization/GetSettingName

Operation ID: ApiServicesAppDashboardcustomizationGetsettingnameGet

Tag: DashboardCustomization

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| application | query | string | No | | |

| dashboardName | query | string | No | | |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: string

Response fields

None

Example response

`json

{

"result": "string",

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/DashboardCustomization/GetSettingName?application=string&dashboardName=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/DashboardCustomization/GetSettingName?application=string&dashboardName=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetUserDashboard

Method: GET

Path: /api/services/app/DashboardCustomization/GetUserDashboard

Operation ID: ApiServicesAppDashboardcustomizationGetuserdashboardGet

Tag: DashboardCustomization

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| DashboardName | query | string | No | | |

| Application | query | string | No | | |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: Dashboard

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| dashboardName | string | No | | |

| pages | array | No | | |

Example response

`json

{

"result": {

"dashboardName": "string",

"pages": [

{

"id": "string",

"name": "string",

"widgets": [

{}

]

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/DashboardCustomization/GetUserDashboard?DashboardName=string&Application=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/DashboardCustomization/GetUserDashboard?DashboardName=string&Application=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

RenamePage

Method: POST

Path: /api/services/app/DashboardCustomization/RenamePage

Operation ID: ApiServicesAppDashboardcustomizationRenamepagePost

Tag: DashboardCustomization

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: RenamePageInput

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| application | string | No | | |

| dashboardName | string | No | | |

| id | string | No | | |

| name | string | No | | |

Example request body

`json

{

"dashboardName": "string",

"id": "string",

"name": "string"

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/DashboardCustomization/RenamePage" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"dashboardName":"string","id":"string","name":"string"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/DashboardCustomization/RenamePage"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"dashboardName": "string",

"id": "string",

"name": "string"

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

SavePage

Method: POST

Path: /api/services/app/DashboardCustomization/SavePage

Operation ID: ApiServicesAppDashboardcustomizationSavepagePost

Tag: DashboardCustomization

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: SavePageInput

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| application | string | No | | |

| dashboardName | string | No | | |

| pages | array | No | | |

Example request body

`json

{

"dashboardName": "string",

"application": "string",

"pages": [

{

"id": "string",

"name": "string",

"widgets": [

{}

]

}

]

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/DashboardCustomization/SavePage" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"dashboardName":"string","application":"string","pages":[{"id":"string","name":"string","widgets":[{}]}]}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/DashboardCustomization/SavePage"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"dashboardName": "string",

"application": "string",

"pages": [

{

"id": "string",

"name": "string",

"widgets": [

{}

]

}

]

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

GetEditionTenantStatistics

Method: GET

Path: /api/services/app/HostDashboard/GetEditionTenantStatistics

Operation ID: ApiServicesAppHostdashboardGeteditiontenantstatisticsGet

Tag: HostDashboard

Authentication: Yes (Bearer token)

Scope: Host

Notes:- Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.

  • This endpoint is typically used in host context (platform administration). Use a host-level account/token and omit Abp.TenantId unless your deployment requires it.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| StartDate | query | string (date-time) | No | | format: date-time |

| EndDate | query | string (date-time) | No | | format: date-time |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetEditionTenantStatisticsOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| editionStatistics | array | No | | |

Example response

`json

{

"result": {

"editionStatistics": [

{

"label": "string",

"value": 0

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/HostDashboard/GetEditionTenantStatistics?StartDate=2025-01-01T00%3A00%3A00Z&EndDate=2025-01-01T00%3A00%3A00Z" \\

-H "Authorization: Bearer " \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/HostDashboard/GetEditionTenantStatistics?StartDate=2025-01-01T00%3A00%3A00Z&EndDate=2025-01-01T00%3A00%3A00Z"

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetIncomeStatistics

Method: GET

Path: /api/services/app/HostDashboard/GetIncomeStatistics

Operation ID: ApiServicesAppHostdashboardGetincomestatisticsGet

Tag: HostDashboard

Authentication: Yes (Bearer token)

Scope: Host

Notes:- Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.

  • This endpoint is typically used in host context (platform administration). Use a host-level account/token and omit Abp.TenantId unless your deployment requires it.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| IncomeStatisticsDateInterval | query | enum(1 | 2 | 3) | No | | format: int32

enum: 1, 2, 3 |

| StartDate | query | string (date-time) | No | | format: date-time |

| EndDate | query | string (date-time) | No | | format: date-time |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetIncomeStatisticsDataOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| incomeStatistics | array | No | | |

Example response

`json

{

"result": {

"incomeStatistics": [

{

"label": "string",

"date": "2025-01-01T00:00:00Z",

"amount": 0

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/HostDashboard/GetIncomeStatistics?IncomeStatisticsDateInterval=1&StartDate=2025-01-01T00%3A00%3A00Z&EndDate=2025-01-01T00%3A00%3A00Z" \\

-H "Authorization: Bearer " \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/HostDashboard/GetIncomeStatistics?IncomeStatisticsDateInterval=1&StartDate=2025-01-01T00%3A00%3A00Z&EndDate=2025-01-01T00%3A00%3A00Z"

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetRecentTenantsData

Method: GET

Path: /api/services/app/HostDashboard/GetRecentTenantsData

Operation ID: ApiServicesAppHostdashboardGetrecenttenantsdataGet

Tag: HostDashboard

Authentication: Yes (Bearer token)

Scope: Host

Notes:- Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.

  • This endpoint is typically used in host context (platform administration). Use a host-level account/token and omit Abp.TenantId unless your deployment requires it.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetRecentTenantsOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| maxRecentTenantsShownCount | integer (int32) | No | | format: int32 |

| recentTenants | array | No | | |

| recentTenantsDayCount | integer (int32) | No | | format: int32 |

| tenantCreationStartDate | string (date-time) | No | | format: date-time |

Example response

`json

{

"result": {

"recentTenantsDayCount": 0,

"maxRecentTenantsShownCount": 0,

"tenantCreationStartDate": "2025-01-01T00:00:00Z"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/HostDashboard/GetRecentTenantsData" \\

-H "Authorization: Bearer " \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/HostDashboard/GetRecentTenantsData"

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetSubscriptionExpiringTenantsData

Method: GET

Path: /api/services/app/HostDashboard/GetSubscriptionExpiringTenantsData

Operation ID: ApiServicesAppHostdashboardGetsubscriptionexpiringtenantsdataGet

Tag: HostDashboard

Authentication: Yes (Bearer token)

Scope: Host

Notes:- Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.

  • This endpoint is typically used in host context (platform administration). Use a host-level account/token and omit Abp.TenantId unless your deployment requires it.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetExpiringTenantsOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| expiringTenants | array | No | | |

| maxExpiringTenantsShownCount | integer (int32) | No | | format: int32 |

| subscriptionEndAlertDayCount | integer (int32) | No | | format: int32 |

| subscriptionEndDateEnd | string (date-time) | No | | format: date-time |

| subscriptionEndDateStart | string (date-time) | No | | format: date-time |

Example response

`json

{

"result": {

"expiringTenants": [

{

"tenantName": "string",

"remainingDayCount": 0

}

],

"subscriptionEndAlertDayCount": 0,

"maxExpiringTenantsShownCount": 0

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/HostDashboard/GetSubscriptionExpiringTenantsData" \\

-H "Authorization: Bearer " \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/HostDashboard/GetSubscriptionExpiringTenantsData"

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetTopStatsData

Method: GET

Path: /api/services/app/HostDashboard/GetTopStatsData

Operation ID: ApiServicesAppHostdashboardGettopstatsdataGet

Tag: HostDashboard

Authentication: Yes (Bearer token)

Scope: Host

Notes:- Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.

  • This endpoint is typically used in host context (platform administration). Use a host-level account/token and omit Abp.TenantId unless your deployment requires it.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| StartDate | query | string (date-time) | No | | format: date-time |

| EndDate | query | string (date-time) | No | | format: date-time |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: TopStatsData

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| dashboardPlaceholder1 | integer (int32) | No | | format: int32 |

| dashboardPlaceholder2 | integer (int32) | No | | format: int32 |

| newSubscriptionAmount | number (double) | No | | format: double |

| newTenantsCount | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"newTenantsCount": 0,

"newSubscriptionAmount": 0,

"dashboardPlaceholder1": 0

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/HostDashboard/GetTopStatsData?StartDate=2025-01-01T00%3A00%3A00Z&EndDate=2025-01-01T00%3A00%3A00Z" \\

-H "Authorization: Bearer " \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/HostDashboard/GetTopStatsData?StartDate=2025-01-01T00%3A00%3A00Z&EndDate=2025-01-01T00%3A00%3A00Z"

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetDailySales

Method: GET

Path: /api/services/app/TenantDashboard/GetDailySales

Operation ID: ApiServicesAppTenantdashboardGetdailysalesGet

Tag: TenantDashboard

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetDailySalesOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| dailySales | array | No | | |

Example response

`json

{

"result": {

"dailySales": [

0

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/TenantDashboard/GetDailySales" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TenantDashboard/GetDailySales"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetDashboardData

Method: GET

Path: /api/services/app/TenantDashboard/GetDashboardData

Operation ID: ApiServicesAppTenantdashboardGetdashboarddataGet

Tag: TenantDashboard

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| SalesSummaryDatePeriod | query | enum(1 | 2 | 3) | No | | format: int32

enum: 1, 2, 3 |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetDashboardDataOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| bouncePercent | integer (int32) | No | | format: int32 |

| dailySales | array | No | | |

| expenses | integer (int32) | No | | format: int32 |

| growth | integer (int32) | No | | format: int32 |

| newFeedbacks | integer (int32) | No | | format: int32 |

| newOrders | integer (int32) | No | | format: int32 |

| newUsers | integer (int32) | No | | format: int32 |

| newVisitPercent | integer (int32) | No | | format: int32 |

| profitShares | array | No | | |

| revenue | integer (int32) | No | | format: int32 |

| salesSummary | array | No | | |

| totalProfit | integer (int32) | No | | format: int32 |

| totalSales | integer (int32) | No | | format: int32 |

| transactionPercent | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"totalProfit": 0,

"newFeedbacks": 0,

"newOrders": 0

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/TenantDashboard/GetDashboardData?SalesSummaryDatePeriod=1" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TenantDashboard/GetDashboardData?SalesSummaryDatePeriod=1"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetGeneralStats

Method: GET

Path: /api/services/app/TenantDashboard/GetGeneralStats

Operation ID: ApiServicesAppTenantdashboardGetgeneralstatsGet

Tag: TenantDashboard

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetGeneralStatsOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| bouncePercent | integer (int32) | No | | format: int32 |

| newVisitPercent | integer (int32) | No | | format: int32 |

| transactionPercent | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"transactionPercent": 0,

"newVisitPercent": 0,

"bouncePercent": 0

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/TenantDashboard/GetGeneralStats" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TenantDashboard/GetGeneralStats"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetMemberActivity

Method: GET

Path: /api/services/app/TenantDashboard/GetMemberActivity

Operation ID: ApiServicesAppTenantdashboardGetmemberactivityGet

Tag: TenantDashboard

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetMemberActivityOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| memberActivities | array | No | | |

Example response

`json

{

"result": {

"memberActivities": [

{

"name": "string",

"earnings": "string",

"cases": 0

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/TenantDashboard/GetMemberActivity" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TenantDashboard/GetMemberActivity"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetProfitShare

Method: GET

Path: /api/services/app/TenantDashboard/GetProfitShare

Operation ID: ApiServicesAppTenantdashboardGetprofitshareGet

Tag: TenantDashboard

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetProfitShareOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| profitShares | array | No | | |

Example response

`json

{

"result": {

"profitShares": [

0

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/TenantDashboard/GetProfitShare" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TenantDashboard/GetProfitShare"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetRegionalStats

Method: GET

Path: /api/services/app/TenantDashboard/GetRegionalStats

Operation ID: ApiServicesAppTenantdashboardGetregionalstatsGet

Tag: TenantDashboard

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetRegionalStatsOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| stats | array | No | | |

Example response

`json

{

"result": {

"stats": [

{

"countryName": "string",

"sales": 0,

"change": [

0

]

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/TenantDashboard/GetRegionalStats" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TenantDashboard/GetRegionalStats"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetSalesSummary

Method: GET

Path: /api/services/app/TenantDashboard/GetSalesSummary

Operation ID: ApiServicesAppTenantdashboardGetsalessummaryGet

Tag: TenantDashboard

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| SalesSummaryDatePeriod | query | enum(1 | 2 | 3) | No | | format: int32

enum: 1, 2, 3 |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetSalesSummaryOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| expenses | integer (int32) | No | | format: int32 |

| growth | integer (int32) | No | | format: int32 |

| revenue | integer (int32) | No | | format: int32 |

| salesSummary | array | No | | |

| totalSales | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"totalSales": 0,

"revenue": 0,

"expenses": 0

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/TenantDashboard/GetSalesSummary?SalesSummaryDatePeriod=1" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TenantDashboard/GetSalesSummary?SalesSummaryDatePeriod=1"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetTopStats

Method: GET

Path: /api/services/app/TenantDashboard/GetTopStats

Operation ID: ApiServicesAppTenantdashboardGettopstatsGet

Tag: TenantDashboard

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetTopStatsOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| newFeedbacks | integer (int32) | No | | format: int32 |

| newOrders | integer (int32) | No | | format: int32 |

| newUsers | integer (int32) | No | | format: int32 |

| totalProfit | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"totalProfit": 0,

"newFeedbacks": 0,

"newOrders": 0

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/TenantDashboard/GetTopStats" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TenantDashboard/GetTopStats"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

Was this article helpful?
0 out of 0 found this helpful