Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetRecommendations

Returns a list of Recommendation objects that contain recommendations for a profiling group for a given time period. A list of Anomaly objects that contains details about anomalies detected in the profiling group for the same time period is also returned.

Request Syntax


GET /internal/profilingGroups/profilingGroupName/recommendations?endTime=endTime&locale=locale&startTime=startTime HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

endTime

The end time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

Required: Yes

locale

The language used to provide analysis. Specify using a string that is one of the following BCP 47 language codes.

de-DE - German, Germany
en-GB - English, United Kingdom
en-US - English, United States
es-ES - Spanish, Spain
fr-FR - French, France
it-IT - Italian, Italy
ja-JP - Japanese, Japan
ko-KR - Korean, Republic of Korea
pt-BR - Portugese, Brazil
zh-CN - Chinese, China
zh-TW - Chinese, Taiwan

profilingGroupName

The name of the profiling group to get analysis data about.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[\w-]+$

Required: Yes

startTime

The start time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "anomalies": [ 
      { 
         "instances": [ 
            { 
               "endTime": "string",
               "id": "string",
               "startTime": "string",
               "userFeedback": { 
                  "type": "string"
               }
            }
         ],
         "metric": { 
            "frameName": "string",
            "threadStates": [ "string" ],
            "type": "string"
         },
         "reason": "string"
      }
   ],
   "profileEndTime": "string",
   "profileStartTime": "string",
   "profilingGroupName": "string",
   "recommendations": [ 
      { 
         "allMatchesCount": number,
         "allMatchesSum": number,
         "endTime": "string",
         "pattern": { 
            "countersToAggregate": [ "string" ],
            "description": "string",
            "id": "string",
            "name": "string",
            "resolutionSteps": "string",
            "targetFrames": [ 
               [ "string" ]
            ],
            "thresholdPercent": number
         },
         "startTime": "string",
         "topMatches": [ 
            { 
               "frameAddress": "string",
               "targetFramesIndex": number,
               "thresholdBreachValue": number
            }
         ]
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

anomalies

The list of anomalies that the analysis has found for this profile.

Type: Array of Anomaly objects

profileEndTime

The end time of the profile the analysis data is about. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

Type: Timestamp

profileStartTime

The start time of the profile the analysis data is about. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

Type: Timestamp

profilingGroupName

The name of the profiling group the analysis data is about.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[\w-]+$

recommendations

The list of recommendations that the analysis found for this profile.

Type: Array of Recommendation objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

The server encountered an internal error and is unable to complete the request.

HTTP Status Code: 500

ResourceNotFoundException

The resource specified in the request does not exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The parameter is not valid.

HTTP Status Code: 400