List of the configured reports.

URL

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

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 that 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 configured reports.

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

The following command retrieves the properties of a specific report.

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

Response

The following is a sample response received when listing reports.

For details of the meta object, see Message format.

{
  "meta": {
    "first": "/api/configuration/reporting/content_subchapters",
    "href": "/api/configuration/reporting/reports",
    "last": "/api/configuration/reporting/statistics_subchapters",
    "next": "/api/configuration/reporting/statistics_subchapters",
    "parent": "/api/configuration/reporting",
    "previous": "/api/configuration/reporting/predefined_reports",
    "transaction": "/api/transaction"
  },
  "items": [
    {
      "key": "7798770004e472c8576912",
      "meta": {
        "href": "/api/configuration/reporting/reports/7798770004e472c8576912"
      }
    },
    {
      "key": "8292675195707f19d932af",
      "meta": {
        "href": "/api/configuration/reporting/reports/8292675195707f19d932af"
      }
    }
  ]
}

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

{
  "body": {
    "access": [
      "report"
    ],
    "chapters": [
      {
        "name": "System health",
        "subchapters": [
          {
            "name": "system_health_network_connections",
            "selection": "builtin"
          },
          {
            "name": "system_health_load_average",
            "selection": "builtin"
          }
        ]
      },
      {
        "name": "All connections",
        "subchapters": [
          {
            "name": "connection_each_scb_top10_channel_types_each",
            "selection": "builtin"
          },
          {
            "name": "connection_each_scb_top10_portforward_targets_each",
            "selection": "builtin"
          }
        ]
      },
      {
        "name": "Search statistics",
        "subchapters": [
          {
            "reference": "21111736175707f1df8bea1",
            "selection": "custom"
          }
        ]
      },
      {
        "name": "Misc",
        "subchapters": [
          {
            "reference": "13869311625707e0a3e0892",
            "selection": "custom"
          }
        ]
      },
      {
        "name": "Advanced statistics",
        "subchapters": [
          {
            "reference": "5983143445707eb740fee3",
            "selection": "custom"
          }
        ]
      }
    ],
    "email_recipients": {
      "recipients": [
        "admin@company.com"
      ],
      "selection": "other"
    },
    "frequency": {
      "day": false,
      "month": true,
      "week": false
    },
    "logo_id": "logoC890jH",
    "name": "all-options",
    "send_report_in_email": true
  },
  "key": "8292675195707f19d932af",
  "meta": {
    "first": "/api/configuration/reporting/reports/7798770004e472c8576912",
    "href": "/api/configuration/reporting/reports/8292675195707f19d932af",
    "last": "/api/configuration/reporting/reports/8292675195707f19d932af",
    "next": null,
    "parent": "/api/configuration/reporting/reports",
    "previous": "/api/configuration/reporting/reports/12046247915707e5d6a5c59",
    "transaction": "/api/transaction"
  }
}

Element			Type	Description
key			string	Top level element, contains the ID of the report
body			Top level element (string)	The elements of the report.
	access		list	Required. List of access control groups whose members can access the subchapter. To deny access to the report, use "admin" as the only value for the element.
	chapters		Top level item	A chapter of the report.
	email_recipients		Top level item	Contains the list of e-mails where the generated report is sent.
		recipients	list	Custom list of e-mails where the generated report is sent. To use a custom list, the selection element must be set to other.
		selection	string	This element can have two values: default uses the e-mail address configured in the reporting_address element of the https://<IP-address-of-SPS>/api/configuration/management/email endpoint (or the Basic Settings > Management > Mail settings > Send reports to field on the web UI). other uses the e-mails listed in the recipients element.
	frequency		Top level item	Contains the list of options for defining the frequency of generating the report.
		day	boolean	Set it to true to generate the report each day.
		month	boolean	Set it to true to generate the report each month.
		week	boolean	Set it to true to generate the report each week.
	logo_id		string	The ID of the custom logo. The null value means the report is generated using the default logo. You can upload a custom logo on the web UI of SPS, using the Reporting > Configuration > <report> > Choose new logo button.
	name		string	The name of the report.
	send_report_in_email		boolean	Set it to false if you do not want to include the generated report in the e-mail.

Chapters elements	Type	Description
name		string	Name of the chapter.
subchapters		list	List of subchapters included in the chapter.
	name	string	Name of the built-in subchapter included in the chapter. For the list of the built-in subchapters, see Built-in subchapters. To include a built-in subchapter, use the value of its name element, not the key.
	reference	string	The key of the custom, content, or statistics subchapter. For the keys of the reporting subchapters created from custom queries to the SPS connection database, see the custom_subchapters endpoint. For the keys of the reporting subchapters created from audit trail content (statistics of search keywords, and screenshots), see the reporting/content_subchapters endpoint. For the keys of the reporting subchapters created from connection statistics, see the reporting/statistics_subchapters endpoint. To include a custom, content, or statistics subchapter, use the value of its key element, not the name.
	selection	string	This element can have two values: Set builtin for the default reporting subchapters. Set custom for all other subchapters (custom, content or statistics).

Examples:

Set the e-mail recipients to the default (as configured in the reporting_address element of the /api/configuration/management/email endpoint):

"email_recipients": {
  "selection": "default"
}

Create a custom set of e-mail recipients:

"email_recipients": {
  "recipients": [
    "<email-1>",
    "<email-2>"
  ],
  "selection": "other"
}

Add a reporting chapter with built-in subchapters:

"chapters": [
  {
    "name": "<custom-name>",
    "subchapters": [
      {
        "name": "system_health_filesystem_usage",
        "selection": "builtin"
      },
      {
        "name": "system_health_network_connections",
        "selection": "builtin"
      },
      {
        "name": "system_health_load_average",
        "selection": "builtin"
      }
    ]
  }

Add a reporting chapter with custom, content, or statistics subchapters:

"chapters": [
  {
    "name": "<custom-name>",
    "subchapters": [
      {
        "reference": "<key-of-subchapter>",
        "selection": "custom"
      },
      {
        "reference": "<key-of-subchapter>",
        "selection": "custom"
      }
    ]
  }
    

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.
400	IncompleteConfigurationSubtreeError	Possible cause: PUT operation on the reports endpoint, instead of POST.
400	IncompleteConfigurationSubtreeError "missing_paths": [ "email_recipients/recipients" ]	You have selected other for the selection element under email_recipients, but did not provide a list using recipients.
400	IncompleteConfigurationSubtreeError Syntax error: \"No such property; property='recipients'	Do not provide recipients if you set the selection element under email_recipients to default.
400	IncompleteConfigurationSubtreeError "missing_paths": [ "chapters/7/subchapters/0/name" ]	Verify that the selection element of the subchapter is correctly set to builtin or custom.
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.
401	AuthenticationFailure	Authenticating the user with the given credentials has failed.
404	NotFound	The requested object does not exist.

Add a report

To add a report, you have to:

1. Open a transaction.

   For details, see Open a transaction.

2. Create the JSON object for the new report.

   POST the JSON object to the https://<IP-address-of-SPS>/api/configuration/reporting/reports 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 report.

   {
     "key": "26ddf648-9a21-4a7f-af56-9cea575785a9",
     "meta": {
       "href": "/api/configuration/reporting/reports/26ddf648-9a21-4a7f-af56-9cea575785a9",
       "parent": "/api/configuration/reporting/reports",
       "transaction": "/api/transaction"
     }
   }

3. Commit your changes.

   For details, see Commit a transaction.

Modify a report

To modify a report, you have to:

1. Open a transaction.

   For details, see Open a transaction.

2. Modify the JSON object of the report.

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

3. Commit your changes.

   For details, see Commit a transaction.