> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/api-en/back-office-api-reference/system-bo-api/member-dashboard.md).

# Member Dashboard

## Retrieve Member Status

> \## Function Description\
> \* Retrieves member status information.\
> \---\
> \## Detailed Description\
> \* Retrieves the number of newly registered members, withdrawn members, and normal members as of the search date.\
> \* Provides the day-over-day change rate for newly registered members, withdrawn members, and normal members.\
> \---\
> \## Revision History\
> \* \`\`\`Release v1.07\_231228\`\`\`: Removed dormant members, reactivated members count, and change rate\
> \* \`\`\`Release v2.00\_240827\`\`\` : Added search period request<br>

````json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"MemberDashBoardRequest":{"type":"object","properties":{"statusPeriod":{"type":"integer","format":"int32","description":"Search Period Type"},"siteNo":{"type":"string","description":"Site No."}},"required":["statusPeriod"]},"MemberDashBoardResponse":{"type":"object","description":"Dashboard Member Status Response DTO","properties":{"newJoinMemCnt":{"type":"integer","format":"int64","description":"New Member Count"},"joinMemCalRate":{"type":"number","format":"double","description":"New Member Change Rate"},"newStpRstMemCnt":{"type":"integer","format":"int64","description":"Reactivated Member Count"},"stpRstMemCalRate":{"type":"number","format":"double","description":"Reactivated Member Change Rate"},"newStpMemCnt":{"type":"integer","format":"int64","description":"Dormant Member Count"},"stpMemCalRate":{"type":"number","format":"double","description":"Dormant Member Change Rate"},"newWdraMemCnt":{"type":"integer","format":"int64","description":"Withdrawn Member Count"},"wdraMemCalRate":{"type":"number","format":"double","description":"Withdrawn Member Change Rate"},"newNorMemCnt":{"type":"integer","format":"int64","description":"Active Member Count"},"norMemCalRate":{"type":"number","format":"double","description":"Active Member Change Rate"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/dashboard/member/getMemberStatus":{"post":{"tags":["Member Dashboard"],"summary":"Retrieve Member Status","description":"## Function Description\n* Retrieves member status information.\n---\n## Detailed Description\n* Retrieves the number of newly registered members, withdrawn members, and normal members as of the search date.\n* Provides the day-over-day change rate for newly registered members, withdrawn members, and normal members.\n---\n## Revision History\n* ```Release v1.07_231228```: Removed dormant members, reactivated members count, and change rate\n* ```Release v2.00_240827``` : Added search period request\n","operationId":"getMemberStatus","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberDashBoardRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MemberDashBoardResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````