Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)
Teams
, (opens new window)
Comala Document Management for Data Center
Results will update as you type.
  • Overview
  • Get started
  • User Guide
  • Workflow Authoring Guide
  • How to's and tutorials
  • Reporting Guide
  • Administration Guides
  • Developer Guides
    • Status REST API
    • Document Activity REST API
      • Document Activity Entries REST API endpoints
      • Document Activity Workflow Usage Statistics REST API endpoints
      • Upgrade and Pre-Upgrade checks REST API endpoints
    • Java API
    • CQL REST API
  • Integration Guides
  • Migrating to Confluence Cloud
  • Release notes
  • Support
    You‘re viewing this with anonymous access, so some content might be blocked.
    /
    Document Activity Entries REST API endpoints
    Updated Jan 08, 2024

    Document Activity Entries REST API endpoints

    1 Endpoints | 1.1 Pages | 1.2 Spaces | 2 Filtering | 3 Pagination | 4 Permissions | 5 Document activity REST API documentation

    DATA CENTER Document Activity REST API

    Overview

    Endpoints

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

    • 1 Pages
    • 2 Spaces

    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"

    By default, each request is limited to 100 items.

    Permissions

    Depending on which of the two 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

    If the request contains a space/page over which the user making the request does not have enough permissions then the response will be a bad request with details about the spaces/pages over which the user does not have enough permissions.

    Document activity REST API documentation

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

    Need support? Create a request with our support team.

    Copyright © 2005 - 2025 Appfire | All rights reserved.

    {"serverDuration": 24, "requestCorrelationId": "0635c4e304684ef1a1d40884b52f74c9"}