Overview

Endpoints

The Document Activity REST API can retrieve workflow document activity entries from the following endpoints

Pages

This endpoint retrieves the document activity entries for a given list of page ids

• http://<confluencehostname>/rest/cw/2/documentactivity/pages

Spaces

This endpoint retrieves the document activity entries for a given list of space keys

• http://<confluencehostname>/rest/cw/2/documentactivity/spaces

Filtering

The requests can include filters to retrieve workflow actions that match any or all of the filters. These are some of the filters available:

• actors to filter by one or more users (by userid) who undertook an action in a document

• participants to filter by one or more users (by userid) who were assigned to an action

• statenames of the workflow states in which the actions took place

• fromdate indicates that the actions must have taken place after it

• todate indicates that the actions must have taken place before it

• types to filter by specific types (e.g. "state", "approval") or subtypes (e.g. "expired", “approvalAssigned“) of actions

Pagination

A query can be separated into multiple requests providing a limit and an offset in order to retrieve all the results in different "pages"

Permissions

Depending on which of the 2 endpoints is used, the following user permissions are required:

• documentactivity/pages: Workflow Visibility over all the provided pages

• documentactivity/spaces: Confluence Space Administrator permission over all the provided spaces

Document activity REST API documentation

The document activity REST API is provided as Open API (Swagger) Documentation.