List of the reporting subchapters created from custom queries to the SPS connection database. The list of tables and fields you can query are described in "Database tables available for custom queries" in the Administration Guide.

URL

GET https://<IP-address-of-SPS>/api/configuration/reporting/custom_subchapters

Cookies

Cookie name	Description	Required	Values
session_id	Contains the authentication token of the user	Required	The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For details on authentication, see Authenticate to the SPS REST API. NOTE: This session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format)..

Sample request

The following command lists the available custom subchapters.

curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/reporting/custom_subchapters

The following command retrieves the properties of a specific subchapter.

curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/reporting/custom_subchapters/<object-id>

Response

The following is a sample response received when listing custom subchapters.

For details of the meta object, see Message format.

{
  "meta": {
    "first": "/api/configuration/reporting/content_subchapters",
    "href": "/api/configuration/reporting/custom_subchapters",
    "last": "/api/configuration/reporting/statistics_subchapters",
    "next": "/api/configuration/reporting/predefined_reports",
    "parent": "/api/configuration/reporting",
    "previous": "/api/configuration/reporting/content_subchapters",
    "transaction": "/api/transaction"
  },
  "items": [
    {
      "key": "5983143445707eb740fee3",
      "meta": {
        "href": "/api/configuration/reporting/custom_subchapters/5983143445707eb740fee3"
      }
    }
  ]
}

When retrieving the endpoint of a specific subchapter, the response is the following.

{
  "body": {
    "access": [
      "search"
    ],
    "chart": {
      "column_titles": [
        "col1",
        "col2"
      ],
      "type": "list"
    },
    "name": "API_test_adv_stats",
    "query": "select\n  to_timestamp(audit_trail_downloads.download_time),\n  audit_trail_downloads.username,\n  channels.channel_type,\n  channels.connection,\n  audit_trail_downloads.ip\nfrom audit_trail_downloads,\n     channels\nwhere channels._connection_channel_id = audit_trail_downloads.id\nand audit_trail_downloads.download_time <= :range_start\nand audit_trail_downloads.download_time > :range_end\nand audit_trail_downloads.username != 'admin'\norder by audit_trail_downloads.download_time;"
  },
  "key": "5983143445707eb740fee3",
  "meta": {
    "first": "/api/configuration/reporting/custom_subchapters/5983143445707eb740fee3",
    "href": "/api/configuration/reporting/custom_subchapters/5983143445707eb740fee3",
    "last": "/api/configuration/reporting/custom_subchapters/5983143445707eb740fee3",
    "next": null,
    "parent": "/api/configuration/reporting/custom_subchapters",
    "previous": null,
    "transaction": "/api/transaction"
  }
}

Element			Type	Description
key			string	Top level element, contains the ID of the custom subchapter.
body			Top level element (string)	The elements of the custom subchapter.
	access		list	Required. List of access control groups whose members can access the subchapter. To deny access to the subchapter, use "admin" as the only value for the element.
	chart		Top level element	Defines the properties of the chart generated from the database query.
		type	string	Defines the chart type. Use bar to generate a bar chart. You have to provide the y_axis_title element for bar charts (its can be null). Use pie to generate pie a chart. Use list to generate a list. You have to provide the column_titles element for lists (it can be null).
		y_axis_title	string	Required if the type element is set to bar. The name of the y axis for the generated bar chart.
		column_titles	list	Required if the type element is set to list. The column titles for the generated list.
	name		string	The name of the subchapter.
	query		string	The SQL database query for creating the subchapter. Caution: Generating a report that includes an Advanced statistics chapter that returns several thousands of entries requires significant CPU and memory resources from One Identity Safeguard for Privileged Sessions (SPS). While generating such a partial report, the web interface of SPS can become slow or unresponsive.

Examples:

Create a bar chart with a custom title for the y-axis:

"chart": {
  "type": "bar",
  "y_axis_title": "Y_axis"
}

Create a pie chart:

"chart": {
  "type": "pie"
}

Create a list with custom column names:

"chart": {
  "column_titles": [
    "col1",
    "col2"
  ],
  "type": "list"
}

Status and error codes

The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.

Code	Description	Notes
201	Created	The new resource was successfully created.
400	InvalidQuery	The requested filter or its value is invalid.
401	Unauthenticated	The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
403	Unauthorized	The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
404	NotFound	The requested object does not exist.

Add a custom subchapter

To add a custom subchapter, you have to:

1. Open a transaction.

   For more information, see Open a transaction.

2. Create the JSON object for the new subchapter.

   POST the JSON object to the https://<IP-address-of-SPS>/api/configuration/reporting/custom_subchapters endpoint. You can find a detailed description of the available parameters listed in Element .

   If the POST request is successful, the response includes the key of the new subchapter. For example:

   {
     "key": "9a8f7f19-edbf-4327-9d3a-9f527e7331ee",
     "meta": {
       "href": "/api/configuration/reporting/custom_subchapters/9a8f7f19-edbf-4327-9d3a-9f527e7331ee",
       "parent": "/api/configuration/reporting/custom_subchapters",
       "transaction": "/api/transaction"
     }
   }

3. Commit your changes.

   For more information, see Commit a transaction.

Modify a custom subchapter

To modify a subchapter, you have to:

1. Open a transaction.

   For more information, see Open a transaction.

2. Modify the JSON object of the subchapter.

   PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/reporting/custom_subchapters/<key-of-the-object> endpoint. You can find a detailed description of the available parameters listed in Element .

3. Commit your changes.

   For more information, see Commit a transaction.