SIGBOX Organization Administrator's Guide
Toggle TOC panel
Generating reports

The Reports page of Organization Administration (below) allows Organization administrators to:

  • access a history of activities * performed by any SIGBOX users who are members of the organization, as well as
  • generate reports of these activities.

The types of activities recorded include:

* Each of these activities involve requests to endpoints of SIGBOX Services' API. For more information about SIGBOX Services' API and its endpoints, see the API Reference Guide page in the API documentation.

Reports page

Activity fields

Each activity (i.e. 'activity item') on the Reports page represents a request to an endpoint of SIGBOX Services API. Each activity on this page consists of the following fields:

Report field Description
Date/time The date and time when the activity was conducted.
Email The email address of the SIGBOX user within the organization whose account was used to perform the activity (i.e. make the request to SIGBOX Services API endpoint).
Action The type of action being conducted by the activity. These action types correspond to the HTTP-based method types used in making requests to endpoints of SIGBOX Services' API:
  • Created (corresponds to a POST method request made to a SIGBOX Services API endpoint) - indicates that the action involved the creation of content/data on SIGBOX Services.
  • Retrieved (corresponds to a GET request made to a SIGBOX Services API endpoint) - indicates that the action involved the retrieval of data from SIGBOX Services.
  • Updated (corresponds to a PUT request made to a SIGBOX Services API endpoint) - indicates that the action involved updating existing content/data on SIGBOX Services.
  • Deleted (corresponds to a DELETE request made to a SIGBOX Services API endpoint) - indicates that the action involved removing existing content/data on SIGBOX Services.
Resource The HTTP-based endpoint of SIGBOX Services API to which the activity's request was made.
Response The HTTP-based status of the response to this activity's request (to SIGBOX Services' API).
Typically, this value is Successful, representing an HTTP response status 200 OK being returned by SIGBOX Services. However, other values (i.e. for failed requests, etc.) may be returned for the response.
IP address The IP address of the computer or device on which the activity was performed.
Client ID

The unique identifier of a client application (configured on the organization's SIGBOX Services instance) through which the activity was conducted.
For more information about client IDs, see the description for Client ID in the SIGBOX Administrator's Guide.

Note: Any activities conducted through SIGBOX for Web or SIGBOX Organization Administration have the client ID value covataWebApp.

Event Info

Important 'event information' returned by SIGBOX Services as a result of the activity.
Depending on the activity's Resource (above, representing a request to a SIGBOX Services API endpoint), data (in the form of properties or JSON object members) may be returned in the response from SIGBOX Services.
Hence, a number of activities on the Reports page are associated with subsets of such data (returned in these activities' responses from SIGBOX Services), which in turn constitutes the important 'event information' associated with these activities.

Note: Event info is only accessible when generating reports of these activities exported to PDF or CSV format. Since a single activity may contain numerous data members for its event info, the Reports page itself does not display this field.

Generating a report

Each time the Reports page is opened, the most recent 25 activities (i.e. API requests) are displayed in reverse chronological order. Older activities can be accessed using the page navigation buttons (lower-right of the Reports page).

Activities on this page can be viewed as well as exported to either PDF or CSV format, where CSV is useful if this report data requires subsequent manipulation.

Due to the heavy volume of activities accessible through this page, it is useful to filter the activities by criteria relevant to your requirements before generating the actual report.

To generate a report of user activities recorded within your organization:

  1. Ensure you are signed in to SIGBOX Organization Administration.
  2. Click the Reports option on the left of the SIGBOX Organization Administration interface to open the Reports page, which displays the most recent 25 activities in reverse chronological order.
  3. Filter the activities according to the following filter fields available at the top of this page:
    Filter field Description
    Start date Specify the date from which activities conducted within your organization will be retrieved for the report.
    End date Specify the date to which activities conducted within your organization will be retrieved for the report.
    Client ID

    The unique identifier of a client application (configured on your organization's SIGBOX Services instance) through which the activity was conducted. For client applications other than SIGBOX (or Safe Share) ones, the client ID value is configured by (and hence, obtainable from) a SIGBOX administrator. Specify the client application's client ID value to retrieve activities for the report, which originate from this application only.
    For more information about client IDs, see the description for Client ID in the SIGBOX Administrator's Guide.

    Note: Any activities conducted by a SIGBOX user through SIGBOX for Web or SIGBOX Organization Administration have the client ID value covataWebApp.

    Email The email address of the SIGBOX user within your organization who conducted the activity. Specify this user's email address to retrieve activities for the report relating to this user only.
    Action The type of action being conducted by the activity. These action types correspond to the HTTP-based method types used in making requests to endpoints of SIGBOX Services' API. Choose one of the following action types to retrieve activities for the report relating to these action types only:
    • Created (corresponds to a POST method request made to a SIGBOX Services API endpoint) - indicates that the action involved the creation of content/data on SIGBOX Services.
    • Retrieved (corresponds to a GET request made to a SIGBOX Services API endpoint) - indicates that the action involved the retrieval of data from SIGBOX Services.
    • Updated (corresponds to a PUT request made to a SIGBOX Services API endpoint) - indicates that the action involved updating existing content/data on SIGBOX Services.
    Note: Activities on the Reports page may have an additional action type (i.e. 'Deleted'), which corresponds to a DELETE method request made to a SIGBOX Services API endpoint. However, it is not possible to filter for activities with this type of action when generating reports through SIGBOX Organization Administration.
    Resource The type (i.e. category) of resource to which the activity relates. These resource types correspond to different categories of endpoints of SIGBOX Services' API. Choose one of the following resource types to retrieve activities for the report relating to these resource types only:
    • Objects - an activity involving the creation, decryption, sharing and management of files.
    • Collaboration - an activity relating to item collaboration. Currently, however, choosing this option retrieves no activities.
    • Keys - an activity relating to the decryption of files (including the decryption of their read-only views).
  4. Do any of the following:
    • Click the View button to filter the activities on the Reports page to items that match all filter field criteria (above).
    • Click the Export drop-down menu and choose:
      • PDF to generate a PDF format document of these activities filtered according to the criteria (above).
      • CSV to generate a CSV format file of these activities filtered according to the criteria (above).
      The PDF and CSV format exports contain the additional Event Info field data (absent from the Reports page), although like the Reports page itself, both formats list their activities in reverse chronological order.