Skip to content

[POST] 키워드별 리포트 조회

Kayoung Yoon edited this page Jan 15, 2021 · 10 revisions
메소드 경로 짧은 설명
POST /reports/detail 리포트 뷰의 키워드별 데이터 (목표, 목표 달성여부, 해당 키워드 기록 개수, 기록별 날짜, 기록별 만족도)를 가져옵니다.

뷰 캡처

요청 헤더

Content-Type: application/json
key 설명 타입 비고
jwt 사용자 인증 토큰 String not Null

요청 바디

key 설명 타입 형식 예시
start 해당 주차의 시작 날짜의 00시00분00초에 해당하는 유닉스 시간 Number 유닉스 시간(밀리초 단위) 1609662202000
end 다음 주차 시작 날짜의 00시00분00초 해당하는 유닉스 시간 Number 유닉스 시간(밀리초 단위) 1609662202000
totalKeywordId 해당 주차의 키워드 중 원하는 것의 totalKeywordId Number 숫자 1

응답 바디

성공

  • 해당 주에 목표가 설정돼있는 경우
{
    "status": 200,
    "success": true,
    "message": "리포트 > 키워드별 조회 성공",
    "data": {
        "totalKeywordId": 17,
        "keywordName": "아웃풋",
        "goalExist": true,
        "weekGoalId": 14,
        "goal": "블로그 포스팅 1개",
        "isGoalCompleted": true,
        "tasks": [
            {
                "taskId": 1,
                "title": "글감 수집하기",
                "date": "2021-01-03T00:00:00.000Z",
                "satisfaction": 5
            },
            {
                "taskId": 2,
                "title": "IT 기술에 관한 아티클 정리하기",
                "date": "2021-01-03T00:00:00.000Z",
                "satisfaction": 3
            },
            {
                "taskId": 8,
                "title": "아티클 리뷰하기",
                "date": "2021-01-03T00:00:00.000Z",
                "satisfaction": 3
            }
        ]
    }
}
  • 해당 주에 목표가 설정돼있지 않은 경우
{
    "status": 200,
    "success": true,
    "message": "리포트 > 키워드별 조회 성공",
    "data": {
        "totalKeywordId": 16,
        "keywordName": "열정",
        "goalExist": false,
        "tasks": [
            {
                "taskId": 22,
                "title": "일주일 계획 세우기",
                "date": "2021-01-11T04:20:30.000Z",
                "satisfaction": 3
            },
            {
                "taskId": 25,
                "title": "대외활동 접수하기",
                "date": "2021-01-11T04:28:01.000Z",
                "satisfaction": 3
            },
            {
                "taskId": 54,
                "title": "놀 땐 놀기",
                "date": "2021-01-13T12:35:53.000Z",
                "satisfaction": 3
            }
        ]
    }
}

실패

  • 입력값에 NULL VALUE
{
    "status": 400,
    "success": false,
    "message": "필요한 값이 없습니다."
}
  • 서버 내부 에러
{
    "status": 500,
    "success": false,
    "message": "서버 내부 에러"
}