DEdefaulr
Documents

Retrieve insights for a document

Changed on

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.

post/documents.insights

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/documents.insights
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getoutline.com/oauth/authorize
      Token URL: https://app.getoutline.com/oauth/token scopes: read, write

Request body

idstring uuid required

Unique identifier for the document.

startDatestring date-time

Start of the insights window (inclusive). Defaults to 30 days ago.

endDatestring date-time

End of the insights window (inclusive). Defaults to today.

Response

OK

Changes