Process observations

Tool	When to use
`get_recent_process_changes`	Find processes that have changed recently.
`get_process_observations`	Understand how a process was performed and where a run differed from the documented approach.
`get_observation_citation`	Examine the activity timeline behind an observation from one of your own sessions.
`list_sessions`	Review individual captures and the people and processes involved.
`get_capture_stats`	Assess capture activity and participation, or compare contributions over time.

get_recent_process_changes

Parameter	Type	Required	Description
`limit`	integer	No	Result limit. Default: `20`. Range: 1–100.

Example request

{
  "context": "Review recent process changes.",
  "limit": 10
}

get_process_observations

Parameter	Type	Required	Description
`process_resource_key`	string	Yes	Process identifier.
`process_version_resource_key`	string or null	No	Process version. Default: `null`.
`limit`	integer	No	Result limit. Default: `5`. Range: 1–100.
`offset`	integer	No	Results to skip. Default: `0`. Minimum: 0.
`verbosity`	string	No	Detail level. Default: `"summary"`. Values: `summary`, `full`.

Example request

{
  "context": "Review captured process activity.",
  "process_resource_key": "process_example",
  "limit": 5
}

get_observation_citation

Parameter	Type	Required	Description
`observation_resource_key`	string	Yes	Observation identifier.
`verbosity`	string	No	Detail level. Default: `"low"`. Values: `low`, `medium`, `high`.
`activity_block_index`	integer or null	No	Activity block to retrieve. Default: `null`. Minimum: 0.

Only citations from your own sessions are available.Example request

{
  "context": "Read evidence from a personal session.",
  "observation_resource_key": "observation_example",
  "verbosity": "medium"
}

list_sessions

Parameter	Type	Required	Description
`published`	boolean or null	No	Filter by publication status. Default: `null`.
`session_types`	array of string or null	No	Capture types. Default: `null`. Values: `companion`, `interview`, `file_upload`.
`statuses`	array of string or null	No	Capture statuses. Default: `null`. Values: `in_progress`, `disconnected`, `processing`, `completed`, `failed`.
`contributors`	array of string or null	No	Contributors to include. Default: `null`.
`time_range`	object	No	Time period.
`time_range.period_days`	integer or null	No	Number of days. Default: `null`. Range: 1–365.
`time_range.since`	string (date-time) or null	No	Start time. Default: `null`.
`time_range.until`	string (date-time) or null	No	End time. Default: `null`.
`sort_by`	string	No	Sort field. Default: `"created_at"`. Values: `created_at`, `type`, `status`, `duration_seconds`.
`sort_order`	string	No	Sort direction. Default: `"desc"`. Values: `asc`, `desc`.
`limit`	integer	No	Result limit. Default: `25`. Range: 1–100.
`offset`	integer	No	Results to skip. Default: `0`. Minimum: 0.

If no time range is supplied, results cover all time.Example request

{
  "context": "Review recent captures.",
  "time_range": {
    "period_days": 7
  },
  "limit": 10
}

get_capture_stats

Parameter	Type	Required	Description
`group_by`	string or null	No	Group results by. Default: `null`. Values: `user`, `session_type`, `session_status`.
`published`	boolean or null	No	Filter by publication status. Default: `null`.
`time_range`	object	No	Time period.
`time_range.period_days`	integer or null	No	Number of days. Default: `null`. Range: 1–365.
`time_range.since`	string (date-time) or null	No	Start time. Default: `null`.
`time_range.until`	string (date-time) or null	No	End time. Default: `null`.
`session_types`	array of string or null	No	Capture types. Default: `null`. Values: `companion`, `interview`, `file_upload`.
`statuses`	array of string or null	No	Capture statuses. Default: `null`. Values: `in_progress`, `disconnected`, `processing`, `completed`, `failed`.
`limit`	integer	No	Result limit. Default: `20`. Range: 1–100.

If no time range is supplied, the reporting window is the trailing 30 days. limit applies only to grouped results.Example request

{
  "context": "Summarize capture activity.",
  "group_by": "session_type",
  "time_range": {
    "period_days": 30
  }
}

Working with evidence