<access-service>/api/v1/dashboard/items/activity

URL structure

https://access-service.xy-company.com/api/v1/dashboard/items/activity

Supported methods and overview

• GET - used to retrieve the total number of Secure Objects in the Created state and collections which have recently been created on the Covata Platform.

Detailed description

This API endpoint retrieves the total numbers of completed Secure Objects (i.e. in the Created state) and collections which have recently been created on the Covata Platform.

By default, the numbers of completed Secure Objects and collections created in the last 24 hours are returned in the response from this API endpoint. However, the numbers of these items which have been created in the last 1 or more hours (up to the last week, i.e. 168 hours) can be retrieved.

Note: This feature is not used on the 'Dashboard' page of Covata Administration.

Supported roles

This API endpoint supports the following Covata user roles (as described in the Covata Platform Administrator's Guide):

• System administrator

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

Required headers

The appropriate access token as the Bearer token:

• Authorization: Bearer a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6

Optional parameters

The following optional parameter can be sent in the URL of the GET request:

• lastHours - An integer value representing the number of hours back from the current time through which to calculate the total numbers of completed Secure Objects and collections that were created.
  Notes:
  • If this parameter is not specified, then a default value of 24 hours is assumed.
  • If a parameter value is specified which is outside the permitted range of 1 to 168 hours, then the default of 24 hours is assumed.
  Example:

  https://access-service.xy-company.com/api/v1/dashboard/items/activity?lastHours=48

Returns

A JSON-formatted response containing the following members:

• objectsCreated - The total number of completed Secure Objects which were created in the last lastHours number of hours.

• collectionsCreated - The total number of collections which were created in the last lastHours number of hours.

  Example:

  {
    "objectsCreated": 6,
    "collectionsCreated": 2
  }