@bachman-dev/wanikani-api-types - v2.0.0
    Preparing search index...

    Interface ReviewStatistic

    Review statistics summarize the activity recorded in reviews. They contain sum the number of correct and incorrect answers for both meaning and reading. They track current and maximum streaks of correct answers. They store the overall percentage of correct answers versus total answers.

    A review statistic is created when the user has done their first review on the related subject.

    interface ReviewStatistic {
        data: {
            created_at: DatableString;
            hidden: boolean;
            meaning_correct: number;
            meaning_current_streak: number;
            meaning_incorrect: number;
            meaning_max_streak: number;
            percentage_correct: number;
            reading_correct: number;
            reading_current_streak: number;
            reading_incorrect: number;
            reading_max_streak: number;
            subject_id: number;
            subject_type: SubjectType;
        };
        data_updated_at: DatableString;
        id: number;
        object: "review_statistic";
        url: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    data: {
        created_at: DatableString;
        hidden: boolean;
        meaning_correct: number;
        meaning_current_streak: number;
        meaning_incorrect: number;
        meaning_max_streak: number;
        percentage_correct: number;
        reading_correct: number;
        reading_current_streak: number;
        reading_incorrect: number;
        reading_max_streak: number;
        subject_id: number;
        subject_type: SubjectType;
    }

    Data for the returned review statistic.

    Type declaration

    • created_at: DatableString

      Timestamp when the review statistic was created.

    • hidden: boolean

      Indicates if the associated subject has been hidden, preventing it from appearing in lessons or reviews.

    • meaning_correct: number

      Total number of correct answers submitted for the meaning of the associated subject.

    • meaning_current_streak: number

      The current, uninterrupted series of correct answers given for the meaning of the associated subject.

    • meaning_incorrect: number

      Total number of incorrect answers submitted for the meaning of the associated subject.

    • meaning_max_streak: number

      The longest, uninterrupted series of correct answers ever given for the meaning of the associated subject.

    • percentage_correct: number

      The overall correct answer rate by the user for the subject, including both meaning and reading.

    • reading_correct: number

      Total number of correct answers submitted for the reading of the associated subject.

    • reading_current_streak: number

      The current, uninterrupted series of correct answers given for the reading of the associated subject.

    • reading_incorrect: number

      Total number of incorrect answers submitted for the reading of the associated subject.

    • reading_max_streak: number

      The longest, uninterrupted series of correct answers ever given for the reading of the associated subject.

    • subject_id: number

      Unique identifier of the associated subject.

    • subject_type: SubjectType

      The type of the associated subject.

    data_updated_at: DatableString

    For a resource, this is the last time that particular resource was updated.

    id: number

    A unique number identifying the review statistic.

    object: "review_statistic"

    The kind of object returned.

    url: string

    The URL of the requested resource.