K

decision-journal

A newer version of this packageis available.
Viewing version
Latest version
Domain
OpenAPI file
An API for keeping track of and reviewing your decisions.

Versions

Decisions

get
/decisions

Get decisions with a query and optional filters as parameters. Refine results by status or whether or not they are due for review.

Path parameters

  • Name
    q
    Type
    string
  • Name
    status
    Type
    string
  • Name
    dueForReview
    Type
    boolean
  • Name
    limit
    Type
    integer

post
/decisions

Create decisions with information about the decision (e.g. title, tags, expected outcomes, feelings, etc). Set the status to "published" when the decision has been made. All decisions not yet made should be "draft" status.

Body params

Name
data
Type
object
Name
title
Type
string
Name
tags
Type
array[string]
Description
Tags for a decision to organize.
Name
status
Type
string
Description
The status of a decision or review.
Name
initialFeeling
Type
string
Description
An initial feeling about a decision.
Name
context
Type
string
Name
expectedOutcome
Type
string
Name
outcomeEstimates
Type
array[object]
Name
text
Type
string
Description
A description of an outcome estimate.
Name
probability
Type
string
Description
A probability of an outcome estimate.
Name
skillLuckWeight
Type
number
Description
A number between 0 and 1 that represents the weight of skill vs luck in the outcome of the decision. 0 means the outcome was entirely due to skill, 1 means the outcome was entirely due to luck.
Name
monthsToNextReview
Type
integer

get
/decisions/{decisionId}

Get a specific decision with its id.

Path parameters

  • Name
    decisionId
    Type
    string
    Required

put
/decisions/{decisionId}

Update a specific decision with information about the decision. Update the decision's status to "published" when the decision has been made.

Path parameters

  • Name
    decisionId
    Type
    string
    Required

Body params

Name
data
Type
object
Name
title
Type
string
Name
tags
Type
array[string]
Description
Tags for a decision to organize.
Name
status
Type
string
Description
The status of a decision or review.
Name
initialFeeling
Type
string
Description
An initial feeling about a decision.
Name
context
Type
string
Name
expectedOutcome
Type
string
Name
outcomeEstimates
Type
array[object]
Name
text
Type
string
Description
A description of an outcome estimate.
Name
probability
Type
string
Description
A probability of an outcome estimate.
Name
skillLuckWeight
Type
number
Description
A number between 0 and 1 that represents the weight of skill vs luck in the outcome of the decision. 0 means the outcome was entirely due to skill, 1 means the outcome was entirely due to luck.
Name
monthsToNextReview
Type
integer

put
/decisions/{decisionId}/reviews

Update a review for a decision with information about the review (e.g. accuracy score, actual outcome, learnings, etc). Set the status to "published" when the review has been finalized. Otherwise, the status should be "draft".

Path parameters

  • Name
    decisionId
    Type
    string
    Required

Body params

Name
data
Type
object
Name
accuracyScore
Type
integer
Name
actualOutcome
Type
string
Name
learningsAndReview
Type
string
Name
status
Type
string
Description
The status of a decision or review.
Name
monthsToNextReview
Type
integer
Description
The number of months until the next review of the parent decision.
Name
outcomeEstimates
Type
array[object]
Name
text
Type
string
Description
A description of an outcome estimate.
Name
probability
Type
string
Description
A probability of an outcome estimate.
Name
itHappened
Type
boolean
Description
Whether or not the outcome estimate happened.

post
/decisions/{decisionId}/reviews

Create a review for a decision with information about the review (e.g. accuracy score, actual outcome, learnings, etc). Set the status to "published" when the review has been finalized. Otherwise, the status should be "draft".

Path parameters

  • Name
    decisionId
    Type
    string
    Required

Body params

Name
data
Type
object
Name
accuracyScore
Type
integer
Name
actualOutcome
Type
string
Name
learningsAndReview
Type
string
Name
status
Type
string
Description
The status of a decision or review.
Name
monthsToNextReview
Type
integer
Description
The number of months until the next review of the parent decision.
Name
outcomeEstimates
Type
array[object]
Name
text
Type
string
Description
A description of an outcome estimate.
Name
probability
Type
string
Description
A probability of an outcome estimate.
Name
itHappened
Type
boolean
Description
Whether or not the outcome estimate happened.