POST request/report/dashboard
Provides a Summary
Request Information
URI Parameters
None.
Body Parameters
DashboardRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| BrandId | integer |
None. |
|
| From | date |
None. |
|
| FuelId | byte |
None. |
|
| ServiceId | byte |
None. |
|
| To | date |
None. |
|
| UserId | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"fuelId": 64,
"brandId": 1,
"userId": 1,
"serviceId": 64,
"from": "2026-10-09T19:01:56.3510301+00:00",
"to": "2026-10-09T19:01:56.3510301+00:00"
}
text/html
Sample:
{"fuelId":64,"brandId":1,"userId":1,"serviceId":64,"from":"2026-10-09T19:01:56.3510301+00:00","to":"2026-10-09T19:01:56.3510301+00:00"}
application/xml, text/xml
Sample:
<DashboardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Reports.Dashboard"> <BrandId>1</BrandId> <From>2026-10-09T19:01:56.3510301+00:00</From> <FuelId>64</FuelId> <ServiceId>64</ServiceId> <To>2026-10-09T19:01:56.3510301+00:00</To> <UserId>1</UserId> </DashboardRequest>
Response Information
Resource Description
DashboardResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| PerformanceTrendData | Collection of PerformanceTrend |
None. |
|
| Summary | DashboardSummary |
None. |
|
| SuppliersBreakDown | Collection of DashboardSupplierContractsStatus |
None. |
|
| TPIContracts | Collection of TPISupplierContract |
None. |
|
| TPIPerformances | Collection of ContractPerformance |
None. |
|
| UserPerformances | Collection of ContractPerformance |
None. |
Response Formats
application/json, text/json
Sample:
{
"summary": {
"totalQuotes": 1,
"totalSubmittedContracts": 2,
"totalLockedInContracts": 3,
"totalContractsObjections": 4,
"totalLiveContracts": 5,
"totalRejectedContracts": 6,
"conversionRate": 7.0,
"totalCustomers": 8.0,
"totalCommission": 9.0,
"totalContractMpans": 1,
"totalContractMprns": 1,
"totalLockedinMpans": 1,
"totalLockedinMprns": 1,
"minimumUplift": 10.0,
"maximumUplift": 11.0,
"averageUplift": 12.0,
"minimumContractLength": 13,
"maximumContractLength": 14,
"averageContractLength": 15.1,
"totalElectricityQuotes": 16,
"totalGasQuotes": 17,
"totalSubmittedElectricityContracts": 18,
"totalSubmittedGasContracts": 19,
"totalLiveElectricityContracts": 20,
"totalLiveGasContracts": 21,
"electricityConversionRate": 22.0,
"gasConversionRate": 23.0,
"totalElectricityCommission": 24.0,
"totalGasCommission": 25.0
},
"performanceTrendData": [
{
"monthId": 64,
"month": "sample string 2",
"quotes": 3,
"contracts": 4
},
{
"monthId": 64,
"month": "sample string 2",
"quotes": 3,
"contracts": 4
}
],
"tpiContracts": [
{
"id": 1,
"name": "sample string 2",
"submitted": 3,
"live": 4,
"rejected": 5,
"inprogress": 6,
"conversion": 7.0,
"suppliersBreakDown": [
{
"id": 1,
"name": "sample string 2",
"submitted": 3,
"live": 4,
"rejected": 5
},
{
"id": 1,
"name": "sample string 2",
"submitted": 3,
"live": 4,
"rejected": 5
}
]
},
{
"id": 1,
"name": "sample string 2",
"submitted": 3,
"live": 4,
"rejected": 5,
"inprogress": 6,
"conversion": 7.0,
"suppliersBreakDown": [
{
"id": 1,
"name": "sample string 2",
"submitted": 3,
"live": 4,
"rejected": 5
},
{
"id": 1,
"name": "sample string 2",
"submitted": 3,
"live": 4,
"rejected": 5
}
]
}
],
"tpiPerformances": [
{
"id": 1,
"name": "sample string 2",
"type": "sample string 3",
"quotes": 4,
"contracts": 5,
"objectedContracts": 6,
"rejectedContracts": 7,
"conversion": 8.0,
"totalCommission": 9.0,
"averageUplift": 10.0
},
{
"id": 1,
"name": "sample string 2",
"type": "sample string 3",
"quotes": 4,
"contracts": 5,
"objectedContracts": 6,
"rejectedContracts": 7,
"conversion": 8.0,
"totalCommission": 9.0,
"averageUplift": 10.0
}
],
"userPerformances": [
{
"id": 1,
"name": "sample string 2",
"type": "sample string 3",
"quotes": 4,
"contracts": 5,
"objectedContracts": 6,
"rejectedContracts": 7,
"conversion": 8.0,
"totalCommission": 9.0,
"averageUplift": 10.0
},
{
"id": 1,
"name": "sample string 2",
"type": "sample string 3",
"quotes": 4,
"contracts": 5,
"objectedContracts": 6,
"rejectedContracts": 7,
"conversion": 8.0,
"totalCommission": 9.0,
"averageUplift": 10.0
}
],
"suppliersBreakDown": [
{
"id": 1,
"name": "sample string 2",
"submitted": 3,
"live": 4,
"rejected": 5
},
{
"id": 1,
"name": "sample string 2",
"submitted": 3,
"live": 4,
"rejected": 5
}
]
}
text/html
Sample:
{"summary":{"totalQuotes":1,"totalSubmittedContracts":2,"totalLockedInContracts":3,"totalContractsObjections":4,"totalLiveContracts":5,"totalRejectedContracts":6,"conversionRate":7.0,"totalCustomers":8.0,"totalCommission":9.0,"totalContractMpans":1,"totalContractMprns":1,"totalLockedinMpans":1,"totalLockedinMprns":1,"minimumUplift":10.0,"maximumUplift":11.0,"averageUplift":12.0,"minimumContractLength":13,"maximumContractLength":14,"averageContractLength":15.1,"totalElectricityQuotes":16,"totalGasQuotes":17,"totalSubmittedElectricityContracts":18,"totalSubmittedGasContracts":19,"totalLiveElectricityContracts":20,"totalLiveGasContracts":21,"electricityConversionRate":22.0,"gasConversionRate":23.0,"totalElectricityCommission":24.0,"totalGasCommission":25.0},"performanceTrendData":[{"monthId":64,"month":"sample string 2","quotes":3,"contracts":4},{"monthId":64,"month":"sample string 2","quotes":3,"contracts":4}],"tpiContracts":[{"id":1,"name":"sample string 2","submitted":3,"live":4,"rejected":5,"inprogress":6,"conversion":7.0,"suppliersBreakDown":[{"id":1,"name":"sample string 2","submitted":3,"live":4,"rejected":5},{"id":1,"name":"sample string 2","submitted":3,"live":4,"rejected":5}]},{"id":1,"name":"sample string 2","submitted":3,"live":4,"rejected":5,"inprogress":6,"conversion":7.0,"suppliersBreakDown":[{"id":1,"name":"sample string 2","submitted":3,"live":4,"rejected":5},{"id":1,"name":"sample string 2","submitted":3,"live":4,"rejected":5}]}],"tpiPerformances":[{"id":1,"name":"sample string 2","type":"sample string 3","quotes":4,"contracts":5,"objectedContracts":6,"rejectedContracts":7,"conversion":8.0,"totalCommission":9.0,"averageUplift":10.0},{"id":1,"name":"sample string 2","type":"sample string 3","quotes":4,"contracts":5,"objectedContracts":6,"rejectedContracts":7,"conversion":8.0,"totalCommission":9.0,"averageUplift":10.0}],"userPerformances":[{"id":1,"name":"sample string 2","type":"sample string 3","quotes":4,"contracts":5,"objectedContracts":6,"rejectedContracts":7,"conversion":8.0,"totalCommission":9.0,"averageUplift":10.0},{"id":1,"name":"sample string 2","type":"sample string 3","quotes":4,"contracts":5,"objectedContracts":6,"rejectedContracts":7,"conversion":8.0,"totalCommission":9.0,"averageUplift":10.0}],"suppliersBreakDown":[{"id":1,"name":"sample string 2","submitted":3,"live":4,"rejected":5},{"id":1,"name":"sample string 2","submitted":3,"live":4,"rejected":5}]}
application/xml, text/xml
Sample:
<DashboardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Reports.Dashboard">
<PerformanceTrendData>
<PerformanceTrend>
<Contracts>4</Contracts>
<Month>sample string 2</Month>
<MonthId>64</MonthId>
<Quotes>3</Quotes>
</PerformanceTrend>
<PerformanceTrend>
<Contracts>4</Contracts>
<Month>sample string 2</Month>
<MonthId>64</MonthId>
<Quotes>3</Quotes>
</PerformanceTrend>
</PerformanceTrendData>
<Summary>
<AverageContractLength>15.1</AverageContractLength>
<AverageUplift>12</AverageUplift>
<ConversionRate>7</ConversionRate>
<ElectricityConversionRate>22</ElectricityConversionRate>
<GasConversionRate>23</GasConversionRate>
<MaximumContractLength>14</MaximumContractLength>
<MaximumUplift>11</MaximumUplift>
<MinimumContractLength>13</MinimumContractLength>
<MinimumUplift>10</MinimumUplift>
<TotalCommission>9</TotalCommission>
<TotalContractMpans>1</TotalContractMpans>
<TotalContractMprns>1</TotalContractMprns>
<TotalContractsObjections>4</TotalContractsObjections>
<TotalCustomers>8</TotalCustomers>
<TotalElectricityCommission>24</TotalElectricityCommission>
<TotalElectricityQuotes>16</TotalElectricityQuotes>
<TotalGasCommission>25</TotalGasCommission>
<TotalGasQuotes>17</TotalGasQuotes>
<TotalLiveContracts>5</TotalLiveContracts>
<TotalLiveElectricityContracts>20</TotalLiveElectricityContracts>
<TotalLiveGasContracts>21</TotalLiveGasContracts>
<TotalLockedInContracts>3</TotalLockedInContracts>
<TotalLockedinMpans>1</TotalLockedinMpans>
<TotalLockedinMprns>1</TotalLockedinMprns>
<TotalQuotes>1</TotalQuotes>
<TotalRejectedContracts>6</TotalRejectedContracts>
<TotalSubmittedContracts>2</TotalSubmittedContracts>
<TotalSubmittedElectricityContracts>18</TotalSubmittedElectricityContracts>
<TotalSubmittedGasContracts>19</TotalSubmittedGasContracts>
</Summary>
<SuppliersBreakDown>
<DashboardSupplierContractsStatus>
<Id>1</Id>
<Live>4</Live>
<Name>sample string 2</Name>
<Rejected>5</Rejected>
<Submitted>3</Submitted>
</DashboardSupplierContractsStatus>
<DashboardSupplierContractsStatus>
<Id>1</Id>
<Live>4</Live>
<Name>sample string 2</Name>
<Rejected>5</Rejected>
<Submitted>3</Submitted>
</DashboardSupplierContractsStatus>
</SuppliersBreakDown>
<TPIContracts>
<TPISupplierContract>
<Conversion>7</Conversion>
<Id>1</Id>
<Inprogress>6</Inprogress>
<Live>4</Live>
<Name>sample string 2</Name>
<Rejected>5</Rejected>
<Submitted>3</Submitted>
<SuppliersBreakDown>
<DashboardSupplierContractsStatus>
<Id>1</Id>
<Live>4</Live>
<Name>sample string 2</Name>
<Rejected>5</Rejected>
<Submitted>3</Submitted>
</DashboardSupplierContractsStatus>
<DashboardSupplierContractsStatus>
<Id>1</Id>
<Live>4</Live>
<Name>sample string 2</Name>
<Rejected>5</Rejected>
<Submitted>3</Submitted>
</DashboardSupplierContractsStatus>
</SuppliersBreakDown>
</TPISupplierContract>
<TPISupplierContract>
<Conversion>7</Conversion>
<Id>1</Id>
<Inprogress>6</Inprogress>
<Live>4</Live>
<Name>sample string 2</Name>
<Rejected>5</Rejected>
<Submitted>3</Submitted>
<SuppliersBreakDown>
<DashboardSupplierContractsStatus>
<Id>1</Id>
<Live>4</Live>
<Name>sample string 2</Name>
<Rejected>5</Rejected>
<Submitted>3</Submitted>
</DashboardSupplierContractsStatus>
<DashboardSupplierContractsStatus>
<Id>1</Id>
<Live>4</Live>
<Name>sample string 2</Name>
<Rejected>5</Rejected>
<Submitted>3</Submitted>
</DashboardSupplierContractsStatus>
</SuppliersBreakDown>
</TPISupplierContract>
</TPIContracts>
<TPIPerformances>
<ContractPerformance>
<AverageUplift>10</AverageUplift>
<Contracts>5</Contracts>
<Conversion>8</Conversion>
<Id>1</Id>
<Name>sample string 2</Name>
<ObjectedContracts>6</ObjectedContracts>
<Quotes>4</Quotes>
<RejectedContracts>7</RejectedContracts>
<TotalCommission>9</TotalCommission>
<Type>sample string 3</Type>
</ContractPerformance>
<ContractPerformance>
<AverageUplift>10</AverageUplift>
<Contracts>5</Contracts>
<Conversion>8</Conversion>
<Id>1</Id>
<Name>sample string 2</Name>
<ObjectedContracts>6</ObjectedContracts>
<Quotes>4</Quotes>
<RejectedContracts>7</RejectedContracts>
<TotalCommission>9</TotalCommission>
<Type>sample string 3</Type>
</ContractPerformance>
</TPIPerformances>
<UserPerformances>
<ContractPerformance>
<AverageUplift>10</AverageUplift>
<Contracts>5</Contracts>
<Conversion>8</Conversion>
<Id>1</Id>
<Name>sample string 2</Name>
<ObjectedContracts>6</ObjectedContracts>
<Quotes>4</Quotes>
<RejectedContracts>7</RejectedContracts>
<TotalCommission>9</TotalCommission>
<Type>sample string 3</Type>
</ContractPerformance>
<ContractPerformance>
<AverageUplift>10</AverageUplift>
<Contracts>5</Contracts>
<Conversion>8</Conversion>
<Id>1</Id>
<Name>sample string 2</Name>
<ObjectedContracts>6</ObjectedContracts>
<Quotes>4</Quotes>
<RejectedContracts>7</RejectedContracts>
<TotalCommission>9</TotalCommission>
<Type>sample string 3</Type>
</ContractPerformance>
</UserPerformances>
</DashboardResponse>