Skip to content
Sesharo Docs

List Period Summaries

GET
/users/{user_id}/period-summaries
curl --request GET \
  --url 'https://example.com/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/period-summaries?period=example&limit=52'

Completed weekly or monthly rollups, newest first (RLS-scoped).

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
user_id
required
User Id
string format: uuid

Query Parameters

Section titled “Query Parameters”
period
required
Period

“week” | “month”

string

“week” | “month”

start_from
Any of:
string format: date
start_to
Any of:
string format: date
limit
Limit
integer
default: 52 >= 1 <= 260

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response List Period Summaries Users User Id Period Summaries Get
Array<object>
PeriodSummaryRead

A weekly/monthly rollup row (or a live preview of the in-progress period).

object
created_at
required
Created At
string format: date-time
day_count
required
Day Count
integer
deviations
required
Deviations
object
key
additional properties
any
event_summary
required
Event Summary
object
key
additional properties
any
id
required
Id
string format: uuid
metrics
required
Metrics
object
key
additional properties
any
notable_score
required
Any of:
number
period_end
required
Period End
string format: date
period_start
required
Period Start
string format: date
period_type
required
Period Type
string
sources
required
Sources
Array<string>
sums
required
Sums
object
key
additional properties
any
updated_at
required
Updated At
string format: date-time
user_id
required
User Id
string format: uuid
Examplegenerated
[
  {
    "created_at": "2026-04-15T12:00:00Z",
    "day_count": 1,
    "deviations": {},
    "event_summary": {},
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "metrics": {},
    "notable_score": 1,
    "period_end": "2026-04-15",
    "period_start": "2026-04-15",
    "period_type": "example",
    "sources": [
      "example"
    ],
    "sums": {},
    "updated_at": "2026-04-15T12:00:00Z",
    "user_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  }
]

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}