Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14107861793.8 KB

Retrieves the analysis results and recommendations for bot optimization. The analysis must be in Available status before recommendations can be retrieved.

Recommendations are returned with pagination support. Each recommendation includes the issue location, priority level, detailed description, and proposed fix.

post/bots/{botId}/botanalyzer/describe/{botAnalyzerRequestId}/

Path parameters

botIdstring required

The unique identifier of the bot.

botAnalyzerRequestIdstring required

The unique identifier of the analysis request.

Request body

nextTokenstring

If the response from a previous request was truncated, the <code>nextToken</code> value is used to retrieve the next page of recommendations.

maxResultsinteger

The maximum number of recommendations to return in the response. The default is 5.

Response

Success

botIdstring

The unique identifier of the bot.

botVersionstring

The version of the bot that was analyzed.

localeIdstring

The locale identifier of the bot locale that was analyzed.

botAnalyzerStatus'Processing' | 'Available' | 'Failed' | 'Stopping' | 'Stopped'
<p>The current status of the analysis.</p> <p>Valid Values: <code>Processing | Available | Failed | Stopping | Stopped</code> </p>
creationDateTimestring date-time

The date and time when the analysis was initiated.

nextTokenstring

If the response is truncated, this token can be used in a subsequent request to retrieve the next page of recommendations.