AE REST API - Usage Data (Telemetry)

The Product Usage Collector (PUC) is an application for Windows or MacOS that is installed by the customer on a system that can access the product to collect usage data (telemetry). The PUC establishes the connection to the target system through a REST API call. For this purpose, the AE REST API provides the productusage endpoint, which allows you to use the PUC to pull your usage data on demand. This connection can only be established with Client 0.

Request: GET http://{host}:{port}/ae/api/v1/{client}/productusage

Example: http://my-jcp-host:8088/ae/api/v1/0/productusage

The following parameters are required and must be used together in epoch time format (including milliseconds separated by a dot):

• start_date

  Defines the starting date for the product usage report.

• end_date

  Defines the ending date for the product usage report.

Example

http://localhost:8088/ae/api/v1/0/productusage?start_date=1639218246.821&end_date=1641896646821

Using pagination is not required, but can be useful if a request to the AE REST API returns numerous results.

The AE REST API allows you to set the following parameters for the productusage endpoint:

• Skip

  Defines the number of records to be skipped for pagination

• Limit

  Defines the maximum number of records to be returned.

Example

http://localhost:8088/ae/api/v1/0/productusage?start_date=1634981659000&end_date=1640259266540&skip=10&limit=20

When the PUC endpoint is called, the system checks if this user requesting the data has the privilege required. If so, the request is processed; otherwise, access is denied.

HTTP 200 Response:

[
	{
		"instance_id": "676d8ef1-6c86-45e5-8a31-3b7c1ea07ff2",
		"product": "AUTOMIC",
		"product_version": "22.0.0+low.build.9999999999",
		"usage": [
			{
				"reporting_end_date": "2021-12-31T10:24:06.821Z",
				"usage": 1,
				"sku": "<xxx>",
				"metric_type": "base_edition",
				"additional_info": ""
			},
			{
				"reporting_end_date": "2021-12-31T10:24:06.821Z",
				"usage": 120,
				"sku": "<xxx>",
				"metric_type": "maximum_active_tech_nodes",
				"additional_info": ""
			},
			{
				"reporting_end_date": "2021-12-31T10:24:06.821Z",
				"usage": 60,
				"sku": "<xxx>",
				"metric_type": "maximum_active_app_nodes",
				"additional_info": ""
			},
			{
				"reporting_end_date": "2021-12-31T10:24:06.821Z",
				"usage": 18,
				"sku": "<xxx>",
				"metric_type": "maximum_active_mainframe_nodes",
				"additional_info": ""
			},
			{
				"reporting_end_date": "2021-12-31T10:24:06.821Z",
				"usage": 1,
				"sku": "<xxx>",
				"metric_type": "high_availability_cluster",
				"additional_info": ""
			}
		]
	}
]