Skip to main content

Report API

The Report API provides ways for the Staff to download the reports.

Endpoints​

# Endpoints
POST
/web/reports/fetch
# Fetch report

Fetch report​

This endpoint fetches a report.

Request (FetchReportReqDTO)​

用戶當前資料

POST /web/reports/fetch
{
  "reportCode": -1,
  "userId": "34273401-01dd-4b95-b3a2-552ba6aec92f"
}

用戶數據

POST /web/reports/fetch
{
  "reportCode": -2,
  "userId": "34273401-01dd-4b95-b3a2-552ba6aec92f",
  "start": "2024-10-03",
  "end": "2024-10-05"
}

用戶步行目標數據

POST /web/reports/fetch
{
  "reportCode": -3,
  "userId": "34273401-01dd-4b95-b3a2-552ba6aec92f",
  "start": "2024-10-03",
  "end": "2024-10-05"
}

用戶每日使用數據

POST /web/reports/fetch
{
  "reportCode": -4,
  "userId": "34273401-01dd-4b95-b3a2-552ba6aec92f",
  "start": "2024-10-03",
  "end": "2024-10-05"
}

用戶實體獎勵兌換數據

POST /web/reports/fetch
{
  "reportCode": -5,
  "userId": "34273401-01dd-4b95-b3a2-552ba6aec92f",
  "start": "2024-10-03",
  "end": "2024-10-05"
}

用戶虛擬獎勵兌換數據

POST /web/reports/fetch
{
  "reportCode": -6,
  "userId": "34273401-01dd-4b95-b3a2-552ba6aec92f",
  "start": "2024-10-03",
  "end": "2024-10-05"
}

應用程式數據報表(機構會員)

POST /web/reports/fetch
{
  "reportCode": 1,
  "centreTypes": [
    1,
    2
  ],
  "districts": [
    "205fb733-23da-11ef-a707-7085c2d96f0d"
  ],
  "start": "2024-10-03",
  "end": "2024-10-05"
}

應用程式數據報表(無機構)

POST /web/reports/fetch
{
  "reportCode": 2,
  "centreTypes": [
    1,
    2
  ],
  "districts": [
    "205fb733-23da-11ef-a707-7085c2d96f0d"
  ],
  "start": "2024-10-03",
  "end": "2024-10-05"
}

每日登入人次報表(機構會員)

POST /web/reports/fetch
{
  "reportCode": 3,
  "centreTypes": [
    1,
    2
  ],
  "districts": [
    "205fb733-23da-11ef-a707-7085c2d96f0d"
  ],
  "start": "2024-10-03",
  "end": "2024-10-05"
}

每日登入人次報表(無機構)

POST /web/reports/fetch
{
  "reportCode": 4,
  "centreTypes": [
    1,
    2
  ],
  "districts": [
    "205fb733-23da-11ef-a707-7085c2d96f0d"
  ],
  "start": "2024-10-03",
  "end": "2024-10-05"
}

每日登入人數報表(機構會員)

POST /web/reports/fetch
{
  "reportCode": 5,
  "centreTypes": [
    1,
    2
  ],
  "districts": [
    "205fb733-23da-11ef-a707-7085c2d96f0d"
  ],
  "start": "2024-10-03",
  "end": "2024-10-05"
}

每日登入人數報表(無機構)

POST /web/reports/fetch
{
  "reportCode": 6,
  "centreTypes": [
    1,
    2
  ],
  "districts": [
    "205fb733-23da-11ef-a707-7085c2d96f0d"
  ],
  "start": "2024-10-03",
  "end": "2024-10-05"
}

用戶每日使用量數據名單

POST /web/reports/fetch
{
  "reportCode": 7,
  "centreTypes": [
    1,
    2
  ],
  "userLevels": [
    0,
    1,
    2
  ],
  "districts": [
    "205fb733-23da-11ef-a707-7085c2d96f0d"
  ],
  "start": "2024-10-03",
  "end": "2024-10-05"
}

精神健康資訊數據報表

POST /web/reports/fetch
{
  "reportCode": 8,
  "centreTypes": [
    1,
    2
  ],
  "userLevels": [
    1,
    2
  ],
  "districts": [
    "205fb733-23da-11ef-a707-7085c2d96f0d"
  ],
  "start": "2024-10-03",
  "end": "2024-10-05"
}

地區資訊數據報表

POST /web/reports/fetch
{
  "reportCode": 9,
  "centreTypes": [
    1,
    2
  ],
  "userLevels": [
    1,
    2
  ],
  "communityEnums": [
    1,
    3,
    4
  ],
  "start": "2024-10-03",
  "end": "2024-10-05"
}

社區資源數據報表

POST /web/reports/fetch
{
  "reportCode": 10,
  "centreTypes": [
    1,
    2
  ],
  "userLevels": [
    1,
    2
  ],
  "communityEnums": [
    1,
    3,
    4
  ],
  "start": "2024-10-03",
  "end": "2024-10-05"
}

兌換數據報表

POST /web/reports/fetch
{
  "reportCode": 11,
  "centreTypes": [
    1,
    2
  ],
  "userLevels": [
    1,
    2
  ],
  "districts": [
    "205fb733-23da-11ef-a707-7085c2d96f0d"
  ],
  "start": "2024-10-03",
  "end": "2024-10-05"
}

實體獎勵用戶兌換名單

POST /web/reports/fetch
{
  "reportCode": 12,
  "centreTypes": [
    1,
    2
  ],
  "userLevels": [
    1,
    2
  ],
  "districts": [
    "205fb733-23da-11ef-a707-7085c2d96f0d"
  ]
}

虛擬獎勵用戶兌換名單

POST /web/reports/fetch
{
  "reportCode": 13,
  "centreTypes": [
    1,
    2
  ],
  "userLevels": [
    1,
    2
  ],
  "districts": [
    "205fb733-23da-11ef-a707-7085c2d96f0d"
  ]
}

用戶數據名單

POST /web/reports/fetch
{
  "reportCode": 14,
  "centreTypes": [
    1,
    2
  ],
  "userLevels": [
    1,
    2
  ],
  "districts": [
    "205fb733-23da-11ef-a707-7085c2d96f0d"
  ]
}

非活躍用戶數據列表

POST /web/reports/fetch
{
  "reportCode": 15,
  "centreTypes": [
    1,
    2
  ],
  "districts": [
    "205fb733-23da-11ef-a707-7085c2d96f0d"
  ]
}

學習課程數據報表

POST /web/reports/fetch
{
  "reportCode": 16,
  "centreTypes": [
    1,
    2
  ],
  "userLevels": [
    1,
    2
  ],
  "districts": [
    "205fb733-23da-11ef-a707-7085c2d96f0d"
  ],
  "start": "2024-10-03",
  "end": "2024-10-05"
}

Response​

It will return the requested file for download

Resources​

FetchReportReqDTO​

properties
  • reportCode
    ReportCode
    required
    The code of the requested report.
  • centreTypes
    CentreType[]
    A list of centre types.
  • userLevels
    UserLevel[]
    A list of user types.
  • districts
    Array
    A list of district IDs.
  • communityEnums
    CommunityEnum[]
    A list of centre types.
  • start
    datetime
    The start time filter in YYYY-mm-dd format.
  • end
    datetime
    The end time filter in YYYY-mm-dd format.

ReportCode​

NameValue
用戶當前資料-1
用戶數據-2
用戶步行目標數據-3
用戶每日使用數據-4
用戶實體獎勵兌換數據-5
用戶虛擬獎勵兌換數據-6
應用程式數據報表(機構會員)1
應用程式數據報表(無機構)2
每日登入人次報表(機構會員)3
每日登入人次報表(無機構)4
每日登入人數報表(機構會員)5
每日登入人數報表(無機構)6
用戶每日使用量數據名單7
精神健康資訊數據報表8
地區資訊數據報表9
社區資源數據報表10
兌換數據報表11
實體獎勵用戶兌換名單12
虛擬獎勵用戶兌換名單13
用戶數據名單14
非活躍用戶數據列表15
學習課程數據報表16

CentreType​

NameValue
香港心理衞生會1
新生精神康復會2
其他0

UserLevel​

NameValue
普通會員0
計劃會員 (Tier 1)1
計劃會員 (Tier 2)2