Skip to content

Document period field on DocumentInsight rollups #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tommoor merged 1 commit into from
May 19, 2026
Merged

Document period field on DocumentInsight rollups #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions spec3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2550,7 +2550,7 @@
"Documents"
],
"summary": "Retrieve insights for a document",
"description": "Retrieve a chronologically sorted array of daily activity rollups (views, comments, reactions, revisions, editors) for a document. Insights must be enabled on the document. Defaults to the last 30 days when no date range is provided.",
"description": "Retrieve a chronologically sorted array of activity rollups (views, comments, reactions, revisions, editors) for a document. Recent activity is returned as daily rollups, while older activity is aggregated into weekly rollups. Insights must be enabled on the document. Defaults to the last 30 days when no date range is provided.",
"requestBody": {
"content": {
"application/json": {
Expand Down Expand Up @@ -9031,12 +9031,20 @@
},
"DocumentInsight": {
"type": "object",
"description": "A daily rollup of activity counts for a document.",
"description": "A rollup of activity counts for a document over a daily or weekly period.",
"properties": {
"date": {
"type": "string",
"format": "date",
"description": "The UTC day the rollup represents."
"description": "The UTC day the rollup represents. For weekly rollups this is the first day (Monday) of the week."
},
"period": {
"type": "string",
"description": "The length of time the rollup covers. Daily rollups are stored for recent activity, older rollups are aggregated into weekly buckets.",
"enum": [
"day",
"week"
]
},
"viewCount": {
"type": "integer",
Expand Down
23 changes: 17 additions & 6 deletions spec3.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1886,10 +1886,11 @@ paths:
tags:
- Documents
summary: Retrieve insights for a document
description: Retrieve a chronologically sorted array of daily activity
rollups (views, comments, reactions, revisions, editors) for a document.
Insights must be enabled on the document. Defaults to the last 30 days
when no date range is provided.
description: Retrieve a chronologically sorted array of activity rollups
(views, comments, reactions, revisions, editors) for a document. Recent
activity is returned as daily rollups, while older activity is
aggregated into weekly rollups. Insights must be enabled on the
document. Defaults to the last 30 days when no date range is provided.
requestBody:
content:
application/json:
Expand Down Expand Up @@ -6263,12 +6264,22 @@ components:
format: date-time
DocumentInsight:
type: object
description: A daily rollup of activity counts for a document.
description: A rollup of activity counts for a document over a daily or weekly
period.
properties:
date:
type: string
format: date
description: The UTC day the rollup represents.
description: The UTC day the rollup represents. For weekly rollups this is
the first day (Monday) of the week.
period:
type: string
description: The length of time the rollup covers. Daily rollups are
stored for recent activity, older rollups are aggregated into
weekly buckets.
enum:
- day
- week
viewCount:
type: integer
description: Total number of document views on this day.
Expand Down
Loading