Skip to content
Ishvana Ishvana Docs

Get Progress Summary

GET
/api/writing/analytics/summary

Get comprehensive progress summary.

Args: days: Number of days of daily progress to include (default 7).

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
days
Days
integer
default: 7

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

AnalyticsStatusResponse[ProgressSummaryResponse]
object
status
required
Status
string
message
required
Message
string
data
Any of:
ProgressSummaryResponse

Progress summary data.

object
goals
Goals
Array<object>
GoalSummaryResponse

Goal summary entry.

object
goalId
required
Goalid
string
goalType
Goaltype
string
""
targetWords
Targetwords
integer
0
currentWords
Currentwords
integer
0
percentage
Percentage
number
0
remaining
Remaining
integer
0
streak
StreakResponse

Writing streak data.

object
current
Current
integer
0
longest
Longest
integer
0
weeklySummary
WeeklySummaryResponse

Weekly summary data.

object
totalWords
Totalwords
integer
0
totalMinutes
Totalminutes
integer
0
daysActive
Daysactive
integer
0
avgWordsPerDay
Avgwordsperday
integer
0
dailyProgress
Dailyprogress
Array<object>
DailyProgressResponse

Daily writing progress entry.

object
date
required
Date
string
words
Words
integer
0
goal
Goal
integer
0
achieved
Achieved
boolean

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object