> For the complete documentation index, see [llms.txt](https://api-docs.myhappyforce.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-docs.myhappyforce.com/docs/api-reference/me-personal-report.md).

# Me Personal Report

## POST /api/v1/employee/me/{employeeId}/report/{reportId}/{reaction}

> React to a report

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"employeeAPISessionId":[]}],"components":{"securitySchemes":{},"schemas":{"ReportReaction":{"type":"string","description":"Reaction to a personal report (like or dislike)","enum":["like","dislike"]},"MePersonalReportDTO":{"allOf":[{"$ref":"#/components/schemas/MePersonalReportHeaderDTO"},{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"date":{"type":"string","format":"date-time"},"liked":{"type":"boolean"},"disliked":{"type":"boolean"},"seen":{"type":"boolean"},"report":{"type":"string"}}}],"description":"Full personal report: header fields plus report content (HTML or text)."},"MePersonalReportHeaderDTO":{"type":"object","description":"Personal report header: id, title, date, liked, disliked, seen. Generated from engagement pulse, HI, etc. for a given month.","properties":{"id":{"type":"string"},"title":{"type":"string"},"date":{"type":"string","format":"date-time"},"liked":{"type":"boolean"},"disliked":{"type":"boolean"},"seen":{"type":"boolean"}}}}},"paths":{"/api/v1/employee/me/{employeeId}/report/{reportId}/{reaction}":{"post":{"tags":["Me Personal Report"],"description":"React to a report","operationId":"markReportReaction","parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string"}},{"name":"reaction","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ReportReaction"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MePersonalReportDTO"}}}}},"deprecated":true}}}}
```

## POST /api/v1/employee/me/{employeeId}/report/{reportId}/seen

> Set's the report as seen

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"employeeAPISessionId":[]}],"components":{"securitySchemes":{},"schemas":{"MePersonalReportDTO":{"allOf":[{"$ref":"#/components/schemas/MePersonalReportHeaderDTO"},{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"date":{"type":"string","format":"date-time"},"liked":{"type":"boolean"},"disliked":{"type":"boolean"},"seen":{"type":"boolean"},"report":{"type":"string"}}}],"description":"Full personal report: header fields plus report content (HTML or text)."},"MePersonalReportHeaderDTO":{"type":"object","description":"Personal report header: id, title, date, liked, disliked, seen. Generated from engagement pulse, HI, etc. for a given month.","properties":{"id":{"type":"string"},"title":{"type":"string"},"date":{"type":"string","format":"date-time"},"liked":{"type":"boolean"},"disliked":{"type":"boolean"},"seen":{"type":"boolean"}}}}},"paths":{"/api/v1/employee/me/{employeeId}/report/{reportId}/seen":{"post":{"tags":["Me Personal Report"],"description":"Set's the report as seen","operationId":"markReportAsSeen","parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MePersonalReportDTO"}}}}},"deprecated":true}}}}
```

## GET /api/v1/employee/me/{employeeId}/report

> Get's the las personal report header the user

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"employeeAPISessionId":[]}],"components":{"securitySchemes":{},"schemas":{"MePersonalReportHeaderDTO":{"type":"object","description":"Personal report header: id, title, date, liked, disliked, seen. Generated from engagement pulse, HI, etc. for a given month.","properties":{"id":{"type":"string"},"title":{"type":"string"},"date":{"type":"string","format":"date-time"},"liked":{"type":"boolean"},"disliked":{"type":"boolean"},"seen":{"type":"boolean"}}}}},"paths":{"/api/v1/employee/me/{employeeId}/report":{"get":{"tags":["Me Personal Report"],"description":"Get's the las personal report header the user","operationId":"getPersonalEngagementReportHeader","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MePersonalReportHeaderDTO"}}}}},"deprecated":true}}}}
```

## GET /api/v1/employee/me/{employeeId}/report/{reportId}/read

> Get's a personal report of the user by Id

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"employeeAPISessionId":[]}],"components":{"securitySchemes":{},"schemas":{"MePersonalReportDTO":{"allOf":[{"$ref":"#/components/schemas/MePersonalReportHeaderDTO"},{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"date":{"type":"string","format":"date-time"},"liked":{"type":"boolean"},"disliked":{"type":"boolean"},"seen":{"type":"boolean"},"report":{"type":"string"}}}],"description":"Full personal report: header fields plus report content (HTML or text)."},"MePersonalReportHeaderDTO":{"type":"object","description":"Personal report header: id, title, date, liked, disliked, seen. Generated from engagement pulse, HI, etc. for a given month.","properties":{"id":{"type":"string"},"title":{"type":"string"},"date":{"type":"string","format":"date-time"},"liked":{"type":"boolean"},"disliked":{"type":"boolean"},"seen":{"type":"boolean"}}}}},"paths":{"/api/v1/employee/me/{employeeId}/report/{reportId}/read":{"get":{"tags":["Me Personal Report"],"description":"Get's a personal report of the user by Id","operationId":"getPersonalEngagementReport","parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MePersonalReportDTO"}}}}},"deprecated":true}}}}
```

## GET /api/v1/employee/me/{employeeId}/report/status

> Get's the personal report status for the current month

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"employeeAPISessionId":[]}],"components":{"securitySchemes":{},"schemas":{"MePersonalReportStatusDTO":{"type":"object","description":"Personal report status: enabled, has current report, pending/completed actions for next report.","properties":{"enabled":{"type":"boolean","description":"Whether personal reports are enabled for the user"},"hasCurrentPersonalReport":{"type":"boolean","description":"Whether the user has a report for the current month"},"pendingForNextReport":{"type":"integer","format":"int32","description":"Number of actions (e.g. score questions) pending for the next report"},"completedForNextReport":{"type":"integer","format":"int32","description":"Number of actions completed for the next report"}}}}},"paths":{"/api/v1/employee/me/{employeeId}/report/status":{"get":{"tags":["Me Personal Report"],"description":"Get's the personal report status for the current month","operationId":"getPersonalEngagementReportStatus","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MePersonalReportStatusDTO"}}}}},"deprecated":true}}}}
```

## GET /api/v1/employee/me/{employeeId}/report/read

> Get's the last personal report of the user

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"employeeAPISessionId":[]}],"components":{"securitySchemes":{},"schemas":{"MePersonalReportDTO":{"allOf":[{"$ref":"#/components/schemas/MePersonalReportHeaderDTO"},{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"date":{"type":"string","format":"date-time"},"liked":{"type":"boolean"},"disliked":{"type":"boolean"},"seen":{"type":"boolean"},"report":{"type":"string"}}}],"description":"Full personal report: header fields plus report content (HTML or text)."},"MePersonalReportHeaderDTO":{"type":"object","description":"Personal report header: id, title, date, liked, disliked, seen. Generated from engagement pulse, HI, etc. for a given month.","properties":{"id":{"type":"string"},"title":{"type":"string"},"date":{"type":"string","format":"date-time"},"liked":{"type":"boolean"},"disliked":{"type":"boolean"},"seen":{"type":"boolean"}}}}},"paths":{"/api/v1/employee/me/{employeeId}/report/read":{"get":{"tags":["Me Personal Report"],"description":"Get's the last personal report of the user","operationId":"getPersonalEngagementReport_1","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MePersonalReportDTO"}}}}},"deprecated":true}}}}
```
