Tarsheed
  1. Reports
Tarsheed
  • Auth
    • Create Account
      POST
    • Verifiy Email
      POST
    • Login
      POST
    • Resend Verfication Code
      POST
    • Forget Password Request
      POST
    • Forget password Verify Code
      POST
    • Reset Password
      PATCH
    • Login With Google
      POST
    • Login With Facebook
      POST
  • Users
    • Get all users
      GET
    • Get specific user
      GET
    • Delete user account
      DELETE
    • Update user data
      PUT
    • Change user password
      PUT
    • Get Recomendation
      GET
    • Get Avarage Cost For Spesfic User
      GET
    • Get The Power Saving Modes Settings
      GET
    • Update the Usage of the power saving mode
      PATCH
  • Reports
    • GetUserReport
      GET
  • Room
    • Create New Room
      POST
    • Update Room
      PATCH
    • Delete Room
      DELETE
    • Get Room Details
      GET
    • Get all Rooms for spesfic user
      GET
  • Device
    • Create New Device
      POST
    • Update Device
      PATCH
    • Delete Device
      DELETE
    • Get All Devices id For IOT System
      GET
    • Toggle Device Status
      PATCH
  • category
    • get all categories
  • Sensor
    • Create New Sensor
    • Update Sensor
    • Delete Sensor
    • Get All Sensor For Spesfic user
  • Automation
    • Add New Automation
    • Get all Automation for Spesfic User
    • Delete Spesfic Automation
    • Update Spesfic Automation
    • Apply Automation Manually
  1. Reports

GetUserReport

Developing
GET
reports

Request

Query Params
targetPeriod
string 
optional
Example:
3-2025

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'reports?targetPeriod=3-2025'

Responses

🟢200Success
application/json
Body
object {0}
Examples
{
    "userId": "680a9b2dcdf756b0e0909dde",
    "totalConsumption": 862,
    "consumptionCost": 979.8,
    "Tier": "6",
    "averageConsumption": 745.875,
    "averageCost": 820.165,
    "previousTotalConsumption": 740,
    "savingsPercentage": -16.49,
    "savingCostPercntage": -21.11,
    "chartData": {
        "1": 100,
        "2": 132,
        "3": 47,
        "4": 139,
        "5": 41,
        "6": 75,
        "7": 67,
        "8": 90,
        "9": 71,
        "10": 100
    }
}
Previous
Update the Usage of the power saving mode
Next
Create New Room
Built with