본문으로 건너뛰기

작품의 리뷰 목록

GET/v1/works/{id}/reviews

작품의 게시된 리뷰를 도움순, 날짜순 또는 점수순으로, 필터와 함께 반환해요.

요청

Shell
curl "https://api.nogitsu.com/v1/works/01a0cb02-0a14-7877-911d-5b4dde76df72/reviews"

매개변수

  • id

    경로필수

    항목의 ID(UUID).

    텍스트

  • sort

    쿼리선택

    결과의 순서.

    텍스트

    허용되는 값helpfulnewesthighestlowest

    기본값: helpful

  • score

    쿼리선택

    이 점수를 준 리뷰만.

    정수

    1부터 10까지

  • language

    쿼리선택

    이 언어로 작성된 리뷰만.

    텍스트

  • completedOnly

    쿼리선택

    true면 작품을 완료한 회원의 리뷰만.

    텍스트

  • detailed

    쿼리선택

    true면 600자 이상의 긴 리뷰만.

    텍스트

  • cursor

    쿼리선택

    이전 페이지의 nextCursor 값. 첫 페이지에서는 생략하세요.

    텍스트

  • limit

    쿼리선택

    한 페이지에 반환할 항목 수.

    정수

    1부터 20까지기본값: 20

응답

요청이 성공하면 다음 JSON과 함께 200으로 응답해요.

  • items객체 목록
    • id텍스트 (uuid)
    • author객체
      • username텍스트
      • displayName텍스트
      • avatarUrl텍스트 (uri)null일 수 있음
    • title텍스트null일 수 있음
    • body객체null일 수 있음
      • blocks여러 형식 중 하나 목록
        1. 옵션 1

          • type텍스트
            허용되는 값paragraph
          • children여러 형식 중 하나 목록
            1. 옵션 1

            2. 옵션 2

            3. 옵션 3

            4. 옵션 4

            5. 옵션 5

        2. 옵션 2

          • type텍스트
            허용되는 값heading
          • children여러 형식 중 하나 목록
            1. 옵션 1

            2. 옵션 2

            3. 옵션 3

            4. 옵션 4

            5. 옵션 5

        3. 옵션 3

          • type텍스트
            허용되는 값quote
          • childrenRichTextBlock 목록
        4. 옵션 4

          • type텍스트
            허용되는 값list
          • isOrderedtrue 또는 false
          • itemsRichTextBlock 목록 목록
        5. 옵션 5

          • type텍스트
            허용되는 값code
          • text텍스트
    • bodyLength정수

      0부터 9007199254740991까지

    • hasSpoilertrue 또는 false
    • spoilerUnit숫자null일 수 있음

      0 이상

    • sourceSpoiler객체null일 수 있음
      • kind텍스트
        허용되는 값mangamanhwamanhuawebtoonnovelother
      • unit숫자null일 수 있음

        0 이상

    • pros텍스트 목록null일 수 있음
    • cons텍스트 목록null일 수 있음
    • images객체 목록
      • url텍스트 (uri)
      • width정수

        0부터 9007199254740991까지

      • height정수

        0부터 9007199254740991까지

      • alt텍스트null일 수 있음
      • variantWidths정수 목록

        0부터 9007199254740991까지

    • language텍스트
    • scoreHalfPoints정수null일 수 있음

      1부터 20까지

    • categoryScores객체
    • trackingStatus텍스트null일 수 있음
      허용되는 값plannedcurrentcompletedpauseddroppedrewatching
    • progressUnits숫자null일 수 있음

      0 이상

    • progressTotal정수null일 수 있음

      0부터 9007199254740991까지

    • repeatCount정수

      0부터 9007199254740991까지

    • authorStats객체
      • reviewCount정수

        0부터 9007199254740991까지

      • helpfulCount정수

        0부터 9007199254740991까지

    • helpfulCount정수

      0부터 9007199254740991까지

    • unhelpfulCount정수

      0부터 9007199254740991까지

    • replyCount정수

      0부터 9007199254740991까지

    • createdAt텍스트 (date-time)
    • editedAt텍스트 (date-time)null일 수 있음
  • nextCursor텍스트null일 수 있음

오류

다른 모든 작업처럼 이 작업도 매개변수가 잘못되면 400, 찾는 것이 없으면 404, 요청을 너무 많이 보내면 429로 응답할 수 있어요. 모든 오류는 같은 형식이에요.

오류 알아보기