Journals (1.0.0)

Download OpenAPI specification:

Journal entries, tags and statistics for client self-reflection

Create, Update, or Delete a Client Journal Entry

Create, update, or delete a journal entry for a client. Journals capture reflections, mood context, and personal insights between sessions — Kana's AI uses journal content to build a richer clinical picture and generate more personalized session insights.

Use this when:

  • Your app captures patient journaling and you want to sync entries into Kana
  • Building a client wellness journaling feature integrated with Kana
  • Storing structured reflections that contribute to AI-generated session summaries

POST — Create a new journal entry. Returns journalid (HTTP 201). PUT /{journalid}/ — Update an existing entry. Returns journalid (HTTP 200). DELETE /{journalid}/ — Soft-delete the entry.

Authorizations:
cookieAuthbasicAuth
Request Body schema:
userid
integer or null
title
string or null <= 255 characters
description
string or null
journal_timestamp
string or null <date-time>

Responses

Request samples

Content type
{
  • "userid": 0,
  • "title": "string",
  • "description": "string",
  • "journal_timestamp": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "userid": 0,
  • "title": "string",
  • "description": "string",
  • "journal_timestamp": "2019-08-24T14:15:22Z"
}

Create, Update, or Delete a Client Journal Entry

Create, update, or delete a journal entry for a client. Journals capture reflections, mood context, and personal insights between sessions — Kana's AI uses journal content to build a richer clinical picture and generate more personalized session insights.

Use this when:

  • Your app captures patient journaling and you want to sync entries into Kana
  • Building a client wellness journaling feature integrated with Kana
  • Storing structured reflections that contribute to AI-generated session summaries

POST — Create a new journal entry. Returns journalid (HTTP 201). PUT /{journalid}/ — Update an existing entry. Returns journalid (HTTP 200). DELETE /{journalid}/ — Soft-delete the entry.

Authorizations:
cookieAuthbasicAuth
path Parameters
journalid
required
integer

A unique integer value identifying this journal.

Request Body schema:
userid
integer or null
title
string or null <= 255 characters
description
string or null
journal_timestamp
string or null <date-time>

Responses

Request samples

Content type
{
  • "userid": 0,
  • "title": "string",
  • "description": "string",
  • "journal_timestamp": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "userid": 0,
  • "title": "string",
  • "description": "string",
  • "journal_timestamp": "2019-08-24T14:15:22Z"
}

Create, Update, or Delete a Client Journal Entry

Create, update, or delete a journal entry for a client. Journals capture reflections, mood context, and personal insights between sessions — Kana's AI uses journal content to build a richer clinical picture and generate more personalized session insights.

Use this when:

  • Your app captures patient journaling and you want to sync entries into Kana
  • Building a client wellness journaling feature integrated with Kana
  • Storing structured reflections that contribute to AI-generated session summaries

POST — Create a new journal entry. Returns journalid (HTTP 201). PUT /{journalid}/ — Update an existing entry. Returns journalid (HTTP 200). DELETE /{journalid}/ — Soft-delete the entry.

Authorizations:
cookieAuthbasicAuth
path Parameters
journalid
required
integer

A unique integer value identifying this journal.

Responses

Retrieve All Journal Entries for a Client

Retrieve all journal entries for a client, sorted by most recent first. Journals contain personal reflections and insights that Kana's AI uses to build clinical context. Use this to display a client's journal history or sync journal data into your system.

Use this when:

  • Displaying a client's reflective journal in your application
  • Syncing journal entries from Kana into your EHR or care record
  • Building a longitudinal client wellness timeline

GET /{userid}/ — Returns all journals sorted by most recent first. HTTP 204 if no journals exist.

Authorizations:
cookieAuthbasicAuthNone

Responses

Retrieve All Journal Entries for a Client

Retrieve all journal entries for a client, sorted by most recent first. Journals contain personal reflections and insights that Kana's AI uses to build clinical context. Use this to display a client's journal history or sync journal data into your system.

Use this when:

  • Displaying a client's reflective journal in your application
  • Syncing journal entries from Kana into your EHR or care record
  • Building a longitudinal client wellness timeline

GET /{userid}/ — Returns all journals sorted by most recent first. HTTP 204 if no journals exist.

Authorizations:
cookieAuthbasicAuthNone
path Parameters
journalid
required
integer

A unique integer value identifying this journal.

Responses

Retrieve Journal Entries for a Client by Date Range

Retrieve all journal entries for a client within a specific date range, ordered most recent first. Useful for building session preparation views or syncing recent journal content into your clinical system.

Use this when:

  • Fetching journal entries written since the last session
  • Displaying journal content for a specific therapy period
  • Syncing date-scoped journal data into your EHR

POST — Accepts userid, fromdate, and todate (YYYY-MM-DD or ISO datetime). Returns journals ordered by most recent. HTTP 204 if none found.

Authorizations:
cookieAuthbasicAuthNone
Request Body schema:
title
string or null <= 255 characters
description
string or null
journal_timestamp
string or null <date-time>
userid
integer or null

Responses

Request samples

Content type
{
  • "title": "string",
  • "description": "string",
  • "journal_timestamp": "2019-08-24T14:15:22Z",
  • "userid": 0
}

Response samples

Content type
application/json
{
  • "journalid": 0,
  • "title": "string",
  • "description": "string",
  • "journal_timestamp": "2019-08-24T14:15:22Z",
  • "userid": 0
}

Get Journal Activity Stats for a Client

Get daily journal write counts for a client over a date range. Returns a breakdown of journaling activity by day — useful for tracking engagement, building wellness dashboards, or monitoring treatment adherence.

Use this when:

  • Building a journaling activity chart or heatmap in your dashboard
  • Measuring client engagement with journaling as part of a care plan

POST — Accepts userid, fromdate (YYYY-MM-DD), and todate (YYYY-MM-DD). Returns {"journalstats": [{"journaldate": ..., "count": ...}]}. HTTP 204 if no journals exist in the range.

Authorizations:
cookieAuthbasicAuthNone
Request Body schema:
userid
integer or null
journal_timestamp
string or null <date-time>

Responses

Request samples

Content type
{
  • "userid": 0,
  • "journal_timestamp": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "journalid": 0,
  • "userid": 0,
  • "journal_timestamp": "2019-08-24T14:15:22Z"
}