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

    Interface LevelProgression

    Level progressions contain information about a user's progress through the WaniKani levels.

    A level progression is created when a user has met the prerequisites for leveling up, which are:

    • Reach a 90% passing rate on assignments for a user's current level with a subject_type of kanji. Passed assignments have data.passed equal to true and a data.passed_at that's in the past.
    • Have access to the level. Under /user, the data.level must be less than or equal to data.subscription.max_level_granted.

    https://docs.api.wanikani.com/20170710/#level-progressions

    interface LevelProgression {
        data: {
            abandoned_at: null | DatableString;
            completed_at: null | DatableString;
            created_at: DatableString;
            level: Level;
            passed_at: null | DatableString;
            started_at: null | DatableString;
            unlocked_at: null | DatableString;
        };
        data_updated_at: DatableString;
        id: number;
        object: "level_progression";
        url: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    data data_updated_at id object url

    Properties

    data: {
        abandoned_at: null | DatableString;
        completed_at: null | DatableString;
        created_at: DatableString;
        level: Level;
        passed_at: null | DatableString;
        started_at: null | DatableString;
        unlocked_at: null | DatableString;
    }

    Data for the returned level progression.

    Type declaration

    • abandoned_at: null | DatableString

      Timestamp when the user abandons the level. This is primarily used when the user initiates a reset.

    • completed_at: null | DatableString

      Timestamp when the user burns 100% of the assignments belonging to the associated subject's level.

    • created_at: DatableString

      Timestamp when the level progression is created.

    • level: Level

      The level of the progression, with possible values from 1 to 60.

    • passed_at: null | DatableString

      Timestamp, in ISO-8601 format, when the user passes at least 90% of the assignments with a type of kanji belonging to the associated subject's level.

    • started_at: null | DatableString

      Timestamp when the user starts their first lesson of a subject belonging to the level.

    • unlocked_at: null | DatableString

      Timestamp when the user can access lessons and reviews for the level.

    data_updated_at: DatableString

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

    id: number

    A unique number identifying the level progression.

    object: "level_progression"

    The kind of object returned.

    url: string

    The URL of the requested resource.

    Settings

    On This Page

    Properties