Skip to content
Ishvana Ishvana Docs

Start Session

POST
/api/writing/analytics/sessions/start

Start a new writing session.

Request Body required

Section titled “Request Body required ”
StartSessionBody

POST /analytics/sessions/start body.

object
documentId
required
Documentid
string
startingWordCount
Startingwordcount
integer
0
activityType
Activitytype
string
default: writing:documents

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

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

Session start data.

object
sessionId
required
Sessionid
string
documentId
required
Documentid
string

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