<access-service>/api/v1/organisations/{orgGroupId}/statistics/items

URL structure

https://access-service.xy-company.com/api/v1/organisations/{orgGroupId}/statistics/items

where {orgGroupId} is the ID of an organisation.

Supported methods and overview

• GET - retrieves a summary of information about the total numbers of file objects/Secure Objects and folders/collections as well as shared and unshared items within an organisation (specified by orgGroupId).

Note: This method takes no parameters.

Detailed description

This API endpoint retrieves a summary of information about the total numbers of file objects and folders as well as shared and unshared items within an organisation (specified by orgGroupId).

The information returned by this API endpoint is utilized on the Organisation Administration dashboard.

Supported roles and conditions

This API endpoint supports the following Cocoon Data user roles (as described in the Organisation Administrator's Guide):

• Organisation administrator - when this user is a member of the organisation whose ID is specified by {orgGroupId} in the request's URL.

The Cocoon Data Platform's resources available to one of these Cocoon Data users (above) is determined by the access token submitted in the header of requests to this endpoint.

Required headers

The appropriate access token as the Bearer token:

• Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...

Returns

If the request succeeded, then an HTTP response status 200 OK is returned.

For successful requests only, a JSON-formatted response containing the following members is also returned:

• objectsCount - The total number of file objects in the organisation (specified by {orgGroupId} in the request's URL).
• collectionsCount - The total number of folders in the organisation (specified by orgGroupId).
• objectsSharedCount - The total number of shared file objects in the organisation (specified by orgGroupId).
• objectsUnsharedCount - The total number of file objects in the organisation (specified by orgGroupId) which have not been shared.
• totalCount - The total number of both file objects and folders (i.e. items) within the organisation specified by orgGroupId.
  Example (response):

  {
      "objectsCount": "5",
      "collectionsCount": "8",
      "objectsSharedCount": "0",
      "objectsUnsharedCount": "5",
      "totalCount": "13"
  }