Journal

Available Methods

List Habits

GET https://api.habitify.me/journal

Filter habits with conditions like Journal screen on client-app.

Query Parameters

Name	Type	Description
target_date	string	See more: Date Format
order_by	string	Enum:priority, reminder_time, status
status	string	See more: Status
area_id	string	The area ID that contains
time_of_day	string	One or multiple enums, join with commas. Enum: morning, afternoon, evening, any_time. Example: morning,evening or any_time or moring

Headers

Name	Type	Description
Authorization	string	API Key

200 The habits matched by conditions:

{
    "message": "Success",
    "data": [
        {
            "id": "-MaRzj4a1xYCzSUvwD8Y",
            "name": "Read Books",
            "is_archived": false,
            "start_date": "2021-05-24T06:10:11.397Z",
            "time_of_day": [
                "any_time"
            ],
            "goal": {
                "unit_type": "min",
                "value": 30,
                "periodicity": "daily"
            },
            "goal_history_items": [
                {
                    "unit_type": "min",
                    "value": 30,
                    "periodicity": "daily"
                }
            ],
            "log_method": "manual",
            "recurrence": "DTSTART:20210524T061011Z\nRRULE:FREQ=DAILY",
            "remind": [
                "21:30"
            ],
            "area": {
                "id": "-MaSRmdoNq9k3JjtvDjh",
                "name": "Productivity",
                "priority": "U"
            },
            "created_date": "2021-05-24T06:10:11.397Z",
            "priority": -6.338253001141147e+29,
            "status": "completed",
            "progress": {
                "current_value": 30,
                "target_value": 30,
                "unit_type": "min",
                "periodicity": "daily",
                "reference_date": "2021-05-26T00:00:00.000Z"
            }
        }
    ],
    "status": true,
    "version": "v1.2"
}

target_date:

All the response habits are running on target_date.

The format of target_date is Date Format.

status:

The status of habit filtering. See more: Status

Constants:

• in_progress

  • The status of the habit is in_progress

• completed

  • The status of the habit is completed

• failed

  • The status of the habit is failed

• skipped

  • The status of the habit is skipped

order_by:

The condition to sort the habits by condition.

Constants:

• priority

  • To order the habits by priority.

• reminder_time

  • To order the habits by reminder time.

• status

  • The order the habits by status. By default: none, in_progress, failed, skipped, completed

time_of_day:

The time of day of the habit

Constants:

• morning:

  • The time of day of the habit is morning.

• afternoon:

  • The time of day of the habit is afternoon.

• evening:

  • The time of day of the habit is evening.

• any_time:

  • The time of day of the habit is all day.

area_id:

The area contains the habits.

area_idand time_of_day is mutually exclusive.