Statistics API

Basic Information

BaseURL

Phase

KIC

AIC

EIC

Description

OP

https://kic-laundry-ext.lgthinq.com

https://aic-laundry-ext.lgthinq.com

https://eic-laundry-ext.lgthinq.com

Operation

QA

https://kic-laundry-ext-qa.lgthinq.com

https://aic-laundry-ext-qa.lgthinq.com

https://eic-laundry-ext-qa.lgthinq.com

Development & Test

API List

API

Method

End-point

Response Format

Summary

[All Devices] Get statistics

GET

{{BASE_URL}}/statistics

JSON

For all devices, retrieve multiple types of statistics at once.

[Multiple Devices] Get statistics

GET

{{BASE_URL}}/statistics/device

JSON

For multiple devices, retrieve  multiple types of statistics at once.

[All Devices] Get course use counts

GET

{{BASE_URL}}/statistics/course

JSON

For all devices, retrieve the course use counts.

[Device] Get course use counts 

GET

{{BASE_URL}}/statistics/course/device/<device-id>

JSON

For the requested device, retrieve the course use count.

[All Devices] Get operation counts

GET

{{BASE_URL}}/statistics/cycle

JSON

For all devices, retrieve the operation counts. 

[Device] Get operation counts

GET

{{BASE_URL}}/statistics/cycle/device/<device-id>

JSON

For the requested device, retrievethe operation count.

[All Devices] Get reservation counts

GET

{{BASE_URL}}/statistics/reserve

JSON

For all devices, retrieve the number of booking counts.

[Device] Get reservation counts

GET

{{BASE_URL}}/statistics/reserve/device/<device-id>

JSON

For the requested device, retrieve the number of booking counts. 

[All Devices] Get Statistics

GET {{BASE_URL}}/statistics

For all devices, retrieve multiple types of statistics at once.

Request

Parameter

Retrieve the daily/weekly/monthly/yearly statistical data for the periodType from startDate to endDate.

Location

Name

Required

Type

Description

Example

Header

Common Header

Mandatory

- - -

Query

startDate

Mandatory

string

Start date

2019-10-11

endDate

Mandatory

string

End date

2019-10-20

periodType

Mandatory

string

Period type

day, week, month, year

timezone

Mandatory

string

Time zone

Asia/Seoul, UTC

type

Mandatory string

Type of statistics to be queried
Multiple entries can be entered by separating them with ','.

course, cycle, reserve

Response

Success

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Name

Type

Required

Description

Example

resultCode

string

Mandatory

Result code

 

result

list

Mandatory

Result Message

 
course

dict

Optional

Statistics related to the number of uses per course

 
 

{date}

dict

Optional

Date (differs according to the requested date and period type) 

2020-06,

2020-06-01

   

total

number

Optional

Total course use count for the period

1

   

washer

dict

Optional

- -
     

30

number

Optional

30 °C

0

     

40

number

Optional

40 °C

0

     

60

number

Optional

60 °C

0

     

75

number

Optional

75 °C

0

     

90

number

Optional

90 °C

0

     

TubClean_Heater

number

Optional

Cleaning the tub

0

     

TubClean_NonHeater

number

Optional

Cleaning the tub

0

     

Hot

number

Optional

Strong

0

     

Warm

number

Optional

Standard

0

     

Cold

number

Optional

Synthetic

0

     

Delicate

number

Optional

Wool

0

     

SpinOnly

number

Optional

Spin-dry only

0

     

Initial_TubClean

number

Optional

Cleaning the tub

0

   

Dryer

dict

Optional

-  
     

HI_TEMP

number

Optional

Strong

0

     

MED_TEMP

number

Optional

Standard

0

     

LOW_TEMP

number

Optional

Weak

0

     

COOLING

number

Optional

Blow

0

cycle

dict

Optional

Statistics related to the operation counts

 
 

{date}

dict

Optional

Date (differs according to the requested date and period type) 

2020-06,

2020-06-01

   

total

number

Optional

Total operation count of all washers and dryers

1

   

washer

dict

Optional

- -
     

cycle

number

Optional

Total operation count

0

     

regular

number

Optional

Paid operation count

0

     

courtesy

number

Optional

Unpaid operation count (Courtesy)

0

   

dryer

dict

Optional

- -
     

cycle

number

Optional

Total operation count

0

     

regular

number

Optional

Paid operation count

0

     

courtesy

number

Optional

Unpaid operation count (Courtesy)

0

reserve

dict

Optional

Statistics related to the number of times booked

 
 

{date}

dict

Optional

Date (differs according to the requested date and period type)  

2020-06,

2020-06-01

   

total

number

Optional

Total reservation counts of all washers and dryers

1

   

washer

number

Optional

Total reservation counts of all washers

0

   

dryer

number

Optional

Total reservation counts of all dryers

1

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to Common Response.

Example

Request

[GET] {{BASE_URL}}/statistics?startDate=2021-01-01&endDate=2021-01-31&periodType=month&timezone=Asia/Seoul&type=course, cycle, reserve

Response

{
  "resultCode": "0000",
  "result": {
    "course": {
      "2021-01": {
        "total": 0,
        "washer": {
          "90": 0,
          "75": 0,
          "60": 0,
          "40": 0,
          "30": 0,
          "TubClean_Heater": 0,
          "TubClean_NonHeater": 0,
          "Hot": 0,
          "Warm": 0,
          "Cold": 0,
          "Delicate": 0,
          "SpinOnly": 0,
          "Initial_TubClean": 0
        },
        "dryer": {
          "HI_TEMP": 0,
          "MED_TEMP": 0,
          "LOW_TEMP": 0,
          "COOLING": 0
        }
      }
    },
    "cycle": {
      "2021-01": {
        "total": 0,
        "washer": {
          "cycle": 0,
          "regular": 0,
          "courtesy": 0
        },
        "dryer": {
          "cycle": 0,
          "regular": 0,
          "courtesy": 0
        }
      }
    },
    "reserve": {
      "2021-01": 0
    }
  }
}

 

[Multiple Devices] Get Statistics

GET {{BASE_URL}}/statistics/device

For multiple devices, retrieve multiple types of statistics at once.

Request

Parameter

Retrieve the daily/weekly/monthly/yearly statistical data for the periodType from startDate to endDate.

Location

Name

Required

Type

Description

Example

Header

Common Header

Mandatory

- - -

Query

startDate

Mandatory

string

Start date

2019-10-11

endDate

Mandatory

string

End date

2019-10-20

periodType

Mandatory

string

Period type

day, week, month, year

timezone

Mandatory

string

Time zone

Asia/Seoul, UTC

type

Mandatory string

Type of statistics to be queried
Multiple entries can be entered by separating them with ','.

course, cycle, reserve
ids Mandatory string

The deviceId list to be queried (Up to 100 devices)

1, 2, 3, 4

Response

Success

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Name

Type

Required

Description

Example

resultCode

string

Mandatory

Result code

 

result

list

Optional

Result Message

 

deviceId

string

Optional

Device ID

 

errCode

string

Optional

Error Code

 

errDescription

string

Optional

Error Description

 

course

dict

Optional

Statistics related to the number of uses per course

 
 

{date}

dict

Optional

Date (differs according to the requested date and period type) 

2020-06,

2020-06-01

   

total

number

Optional

Total course use count for the period

1

   

washer

dict

Optional

- -
     

30

number

Optional

30 °C

0

     

40

number

Optional

40 °C

0

     

60

number

Optional

60 °C

0

     

75

number

Optional

75 °C

0

     

90

number

Optional

90 °C

0

     

TubClean_Heater

number

Optional

Cleaning the tub

0

     

TubClean_NonHeater

number

Optional

Cleaning the tub

0

     

Hot

number

Optional

Strong

0

     

Warm

number

Optional

Standard

0

     

Cold

number

Optional

Synthetic

0

     

Delicate

number

Optional

Wool

0

     

SpinOnly

number

Optional

Spin-dry only

0

     

Initial_TubClean

number

Optional

Cleaning the tub

0

   

Dryer

dict

Optional

-  
     

HI_TEMP

number

Optional

Strong

0

     

MED_TEMP

number

Optional

Standard

0

     

LOW_TEMP

number

Optional

Weak

0

     

COOLING

number

Optional

Blow

0

cycle

dict

Optional

Statistics related to the operation counts

 
 

{date}

dict

Optional

Date (differs according to the requested date and period type) 

2020-06,

2020-06-01

   

total

number

Optional

Total operation count of all washers and dryers

1

   

washer

dict

Optional

- -
     

cycle

number

Optional

Total operation count

0

     

regular

number

Optional

Paid operation count

0

     

courtesy

number

Optional

Unpaid operation count (Courtesy)

0

   

dryer

dict

Optional

- -
     

cycle

number

Optional

Total operation count

0

     

regular

number

Optional

Paid operation count

0

     

courtesy

number

Optional

Unpaid operation count (Courtesy)

0

reserve

dict

Optional

Statistics related to the number of times booked

 
 

{date}

dict

Optional

Date (differs according to the requested date and period type)  

2020-06,

2020-06-01

   

total

number

Optional

Total reservation counts of the washers and dryers

 

1

   

washer

number

Optional

Reservation counts of the washers

0

   

dryer

number

Optional

Reservation counts of the dryers

1

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to Common Response.

Example

Request

[GET] {{BASE_URL}}/statistics/device?startDate=2021-01-01&endDate=2021-01-31&periodType=month&timezone=Asia/Seoul&type=course, cycle, reserve&ids=4138737e7eb621c26138f89f60b646671b03cf30817a7f55a7eb1e0af4aa501e, 1111

Response

{
  "resultCode": "0000",
  "result": {
    "course": {
      "2021-01": {
        "total": 0,
        "washer": {
          "90": 0,
          "75": 0,
          "60": 0,
          "40": 0,
          "30": 0,
          "TubClean_Heater": 0,
          "TubClean_NonHeater": 0,
          "Hot": 0,
          "Warm": 0,
          "Cold": 0,
          "Delicate": 0,
          "SpinOnly": 0,
          "Initial_TubClean": 0
        },
        "dryer": {
          "HI_TEMP": 0,
          "MED_TEMP": 0,
          "LOW_TEMP": 0,
          "COOLING": 0
        }
      }
    },
    "cycle": {
      "2021-01": {
        "total": 0,
        "washer": {
          "cycle": 0,
          "regular": 0,
          "courtesy": 0
        },
        "dryer": {
          "cycle": 0,
          "regular": 0,
          "courtesy": 0
        }
      }
    },
    "reserve": {
      "2021-01": 0
    }
  }
}

 

[All Devices] Get Course Use Counts

GET {{BASE_URL}}/statistics/course

Retrieve the course use counts of all devices for the requested period.

Request

Parameter

Retrieve the daily/weekly/monthly/yearly statistical data for the periodType from startDate to endDate.

Location

Name

Required

Type

Description

Example

Header

Common Header

Mandatory

- - -

Query

startDate

Mandatory

string

Start date

2019-10-11

endDate

Mandatory

string

End date

2019-10-20

periodType

Mandatory

string

Period type

day, week, month, year

timezone

Mandatory

string

Time zone

Asia/Seoul, UTC

Response

Success

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Name

Type

Required

Description

Example

resultCode

string

Mandatory

Result code

 

result

list

Mandatory

Result Message

 

{date}

dict

Mandatory

Date (differs according to the requested date and period type) 

2020-06,

2020-06-01

 

total

number

Mandatory

Total course use count for the period

1

 

washer

dict

Optional

- -
   

30

number

Optional

30 °C

0

   

40

number

Optional

40 °C

0

   

60

number

Optional

60 °C

0

   

75

number

Optional

75 °C

0

   

90

number

Optional

90 °C

0

   

TubClean_Heater

number

Optional

Cleaning the tub

0

   

TubClean_NonHeater

number

Optional

Cleaning the tub

0

   

Hot

number

Optional

Strong

0

   

Warm

number

Optional

Standard

0

   

Cold

number

Optional

Synthetic

0

   

Delicate

number

Optional

Wool

0

   

SpinOnly

number

Optional

Spin-dry only

0

   

Initial_TubClean

number

Optional

Cleaning the tub

0

 

Dryer

dict

Optional

-  
   

HI_TEMP

number

Optional

Strong

0

   

MED_TEMP

number

Optional

Standard

0

   

LOW_TEMP

number

Optional

Weak

0

   

COOLING

number

Optional

Blow

0

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to Common Response.

Example

Request

[GET] {{BASE_URL}}/statistics/course?startDate=2020-06-01&endDate=2020-06-30&periodType=month&timezone=Asia/Seoul

Response

{
  "resultCode": "0000",
  "result": {
    "2020-06": {
      "total": 0,
      "washer": {
        "90": 0,
        "75": 0,
        "60": 0,
        "40": 0,
        "30": 0,
        "TubClean_Heater": 0,
        "TubClean_NonHeater": 0,
        "Hot": 0,
        "Warm": 0,
        "Cold": 0,
        "Delicate": 0,
        "SpinOnly": 0,
        "Initial_TubClean": 0
      },
      "dryer": {
        "HI_TEMP": 0,
        "MED_TEMP": 0,
        "LOW_TEMP": 0,
        "COOLING": 0
      }
    }
  }
}

 

[Device] Get Course Use Counts

GET {{BASE_URL}}/statistics/course/device/<device-id>

Retrieve the course use counts of the requested device for the requested period.

Request

Parameter

Retrieve the daily/weekly/monthly/yearly statistical data for the periodType from startDate to endDate.

Location

Name

Required

Type

Description

Example

Header

Common Header

Mandatory

- - -

Path

device-id

Mandatory

string

Device ID

07dcf5b1-fd14-104d-8d6a-203dbdb9b139

Query

startDate

Mandatory

string

Start date

2019-10-11

endDate

Mandatory

string

End date

2019-10-20

periodType

Mandatory

string

Period type

day, week, month, year

timezone

Mandatory

string

Time zone

Asia/Seoul, UTC

Response

Success

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Name

Type

Required

Description

Example

resultCode

string

Mandatory

Result code

 

result

list

Mandatory

Result Message

 

{date}

dict

Mandatory

Date (differs according to the requested date and period type)

2020-06,

2020-06-01

 

total

number

Mandatory

Total course use count for the period

1

 

washer

dict

Optional

- -
   

30

number

Optional

30 °C

0

   

40

number

Optional

40 °C

0

   

60

number

Optional

60 °C

0

   

75

number

Optional

75 °C

0

   

90

number

Optional

90 °C

0

   

TubClean_Heater

number

Optional

Cleaning the tub

0

   

TubClean_NonHeater

number

Optional

Cleaning the tub

0

   

Hot

number

Optional

Strong

0

   

Warm

number

Optional

Standard

0

   

Cold

number

Optional

Synthetic

0

   

Delicate

number

Optional

Wool

0

   

SpinOnly

number

Optional

Spin-dry only

0

   

Initial_TubClean

number

Optional

Cleaning the tub

0

 

Dryer

dict

Optional

-  
   

HI_TEMP

number

Optional

Strong

0

   

MED_TEMP

number

Optional

Standard

0

   

LOW_TEMP

number

Optional

Weak

0

   

COOLING

number

Optional

Blow

0

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to Common Response.

Example

Request

[GET] {{BASE_URL}}/statistics/course/device/{device-id}?startDate=2020-06-01&endDate=2020-06-30&periodType=month

Response

{
  "resultCode": "0000",
  "result": {
    "2020-06": {
      "total": 0,
      "washer": {
        "90": 0,
        "75": 0,
        "60": 0,
        "40": 0,
        "30": 0,
        "TubClean_Heater": 0,
        "TubClean_NonHeater": 0,
        "Hot": 0,
        "Warm": 0,
        "Cold": 0,
        "Delicate": 0,
        "SpinOnly": 0,
        "Initial_TubClean": 0
      },
      "dryer": {
        "HI_TEMP": 0,
        "MED_TEMP": 0,
        "LOW_TEMP": 0,
        "COOLING": 0
      }
    }
  }
}

 

[All Devices] Get Operation Counts

GET {{BASE_URL}}/statistics/cycle

Retrieve the operation counts of all devices for the requested period for the requested period.

Request

Parameter

Retrieve the daily/weekly/monthly/yearly statistical data for the periodType from startDate to endDate.

Location

Name

Required

Type

Description

Example

Header

Common Header

Mandatory

- - -

Query

startDate

Mandatory

string

Start date

2019-10-11

endDate

Mandatory

string

End date

2019-10-20

periodType

Mandatory

string

Period type

day, week, month, year

timezone

Mandatory

string

Time zone

Asia/Seoul, UTC

Response

Success

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Name

Type

Required

Description

Example

resultCode

string

Mandatory

Result code

"0000"

result

list

Optional

Result Message

-

{date}

dict

Optional

Date (differs according to the requested date and period type) 

2020-06,

2020-06-01

 

total

number

Optional

Total operation count of all washers and dryers

1

 

washer

dict

Optional

- -
   

cycle

number

Optional

Total operation count

0

   

regular

number

Optional

Paid operation count

0

   

courtesy

number

Optional

Unpaid operation count (Courtesy)

0

 

dryer

dict

Optional

- -
   

cycle

number

Optional

Total operation count

0

   

regular

number

Optional

Paid operation count

0

   

courtesy

number

Optional

Unpaid operation count (Courtesy)

0

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to Common Response.

Example

Request

[GET] {{BASE_URL}}/statistics/cycle?startDate=2020-06-01&endDate=2020-06-30&periodType=month&timezone=Asia/Seoul

Response

{
  "resultCode": "0000",
  "result": {
    "2020-06": {
      "total": 0,
      "washer": {
        "cycle": 0,
        "regular": 0,
        "courtesy": 0
      },
      "dryer": {
        "cycle": 0,
        "regular": 0,
        "courtesy": 0
      }
    }
  }
}

 

[Device] Get Operation Counts

GET {{BASE_URL}}/statistics/cycle/<device-id>

Retrieve the operation counts of the requested device for the requested period.

Request

Parameter

Retrieve the daily/weekly/monthly/yearly statistical data for the periodType from startDate to endDate.

Location

Name

Required

Type

Description

Example

Header

Common Header

Mandatory

- - -

Path

device-id

Mandatory

string

Device ID

07dcf5b1-fd14-104d-8d6a-203dbdb9b139

Query

startDate

Mandatory

string

Start date

2019-10-11

endDate

Mandatory

string

End date

2019-10-20

periodType

Mandatory

string

Period type

day, week, month, year

timezone

Mandatory

string

Time zone

Asia/Seoul, UTC

Response

Success 

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Name

Type

Required

Description

Example

resultCode

string

Mandatory

Result code

"0000"

result

list

Optional

Result Message

-

{date}

dict

Optional

Date (differs according to the requested date and period type)

2020-06,

2020-06-01

 

total

number

Optional

Total operation count of all washers and dryers

1

 

washer

dict

Optional

- -
   

cycle

number

Optional

Total operation count

0

   

regular

number

Optional

Paid operation count

0

   

courtesy

number

Optional

Unpaid operation count (Courtesy)

0

 

dryer

dict

Optional

- -
   

cycle

number

Optional

Total operation count

0

   

regular

number

Optional

Paid operation count

0

   

courtesy

number

Optional

Unpaid operation count (Courtesy)

0

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to Common Response.

Example

Request

[GET] {{BASE_URL}}/statistics/cycle/device/{device-id}?startDate=2020-06-01&endDate=2020-06-30&periodType=month&timezone=Asia/Seoul

Response

{
  "resultCode": "0000",
  "result": {
    "2020-06": {
      "total": 0,
      "washer": {
        "cycle": 0,
        "regular": 0,
        "courtesy": 0
      },
      "dryer": {
        "cycle": 0,
        "regular": 0,
        "courtesy": 0
      }
    }
  }
}

 

[All Devices] Get Reservation Counts

GET {{ENDPOINT_URL}}/statistics/reserve

Retrieve the number of times that all devices were booked for the requested period.

Request

Parameter

Retrieve the daily/weekly/monthly/yearly statistical data for the periodType from startDate to endDate.

Location

Name

Required

Type

Description

Example

Header

Common Header

Mandatory

- - -

Query

startDate

Mandatory

string

Start date

2019-10-11

endDate

Mandatory

string

End date

2019-10-20

periodType

Mandatory

string

Period type

day, week, month, year

timezone

Mandatory

string

Time zone

Asia/Seoul, UTC

Response

Success

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Name

Type

Required

Description

Example

resultCode

string

Mandatory

Result code

"0000"

result

list

-

Result Message

-

{date}

dict

Mandatory

Date (differs according to the requested date and period type)  

2020-06,

2020-06-01

 

total

number

Mandatory

Total locking count of all washers and dryers

1

 

washer

number

Mandatory

The number of times the washing machines were booked

0

 

dryer

number

Mandatory

The number of times the dryers were booked

1

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to Common Response.

Example

Request

[GET] {{BASE_URL}}/statistics/reserve?startDate=2020-06-01&endDate=2020-06-30&periodType=month

Response

{
  "resultCode": "0000",
  "result": {
    "2020-06": {
      "total": 0,
      "washer": 0,
      "dryer": 0
    }
  }
}

 

[Device] Get Reservation Counts

GET {{BASE_URL}}/statistics/reserve/device/<device-id>

Retrieve the number of times that the device was booked for the requested period.

Request

Parameter

Retrieve the daily/weekly/monthly/yearly statistical data for the periodType from startDate to endDate.

Location

Name

Required

Type

Description

Example

Header

Common Header

Mandatory

- - -
Path

device-id

Mandatory

string

Device ID

07dcf5b1-fd14-104d-8d6a-203dbdb9b139

Query

startDate

Mandatory

string

Start date

2019-10-11

endDate

Mandatory

string

End date

2019-10-20

periodType

Mandatory

string

Period type

day, week, month, year

timezone

Mandatory

string

Time zone

Asia/Seoul, UTC

Response

Success

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Name

Type

Required

Description

Example

resultCode

string

Mandatory

Result Code

"0000"

result

list

-

Result Message

-

{date}

dict

Mandatory

Date (differs according to the requested date and period type) 

2020-06,

2020-06-01

 

total

number

Mandatory

Total locking count of all washers and dryers

1

 

washer

number

Mandatory

The number of times the washing machine was booked

0

 

dryer

number

Mandatory

The number of times the dryer was booked

1

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to Common Response.

Example

Request

[GET] {{BASE_URL}}/statistics/reserve/device/{device-id}?startDate=2020-06-01&endDate=2020-06-30&periodType=month

Response

{
  "resultCode": "0000",
  "result": {
    "2020-06": {
      "total": 0,
      "washer": 0,
      "dryer": 0
    }
  }
}