Contents

Get Performance Test Results

Gets the results of the performance test for the specified identifier.

URL

GET https://api.storekit-sandbox.apple.com/inApps/v1/messaging/performanceTest/result/{requestId}

Sandbox URL

GET https://api.storekit-sandbox.apple.com/inApps/v1/messaging/performanceTest/result/{requestId}

Path Parameters

NameTypeDescription
requestId RequiredrequestId

The ID of the performance test to return, which you receive in the PerformanceTestResponse when you call Initiate Performance Test.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
PerformanceTestResultResponse

Request succeeded.

400Bad Request
Content-Type: application/json
InvalidRequestIdError

The request is invalid and unacceptable.

401Unauthorized

The JSON Web Token (JWT) in the authorization header is invalid. For more information, see Generating JSON Web Tokens for API requests.

404Not Found
Content-Type: application/json
PerformanceTestRunNotFoundError

The system can’t find the message.

429
Content-Type: application/json
RateLimitExceededError

The request exceeded the rate limit. For more information, see Identifying rate limits.

500Internal Server Error
Content-Type: application/json
GeneralInternalError

Server error. Try again later.

Mentioned in

Discussion

Call this endpoint to retrieve the results from a performance test you initiate by calling Initiate Performance Test.

The API returns a JSON object that contains PerformanceTestConfig, PerformanceTestResponse , and Failures objects that enumerate the parameters the system used to evaluate the server performance, results of the specified test, and information that describes the failures, if any, that the test encountered.

See Also

Server performance testing