Initiate Performance Test
Initiates a performance test of your Get Retention Message endpoint in the sandbox environment.
URL
POST https://api.storekit-sandbox.apple.com/inApps/v1/messaging/performanceTestSandbox URL
POST https://api.storekit-sandbox.apple.com/inApps/v1/messaging/performanceTestResponse Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | PerformanceTestResponse | Request succeeded. |
| 400 | Bad Request Content-Type: application/json | (InvalidPerformanceTestRequestError | ExistingPerformanceTestRunError | BadRequestTransactionIdError | BadRequestAppTransactionIdForUnsupportedEndpointError | BadRequestTransactionIdNotSupportedForFamilySharingError | BadRequestTransactionIdNotOtidError) | The request is invalid and unacceptable. |
| 401 | Unauthorized | The JSON Web Token (JWT) in the authorization header is invalid. For more information, see Generating JSON Web Tokens for API requests. | |
| 404 | Not Found | The request is invalid because the developer account doesn’t have access to this API. For more information, see Request access to the Retention Messaging API. | |
| 429 | Content-Type: application/json | RateLimitExceededError | The request exceeded the rate limit. For more information, see Identifying rate limits. |
| 500 | Internal Server Error Content-Type: application/json | GeneralInternalError | Server error. Try again later. |
Mentioned in
Discussion
Call this endpoint after you configure your Get Retention Message endpoint for the sandbox environment to test your server’s performance. The service returns a response that includes a PerformanceTestConfig object that describes the testing parameters and a requestId you can use to request test results.
To pass the performance test, your server must respond to requests within approximately 700 ms in the sandbox environment. For a more precise response-time value, run the test and check the PerformanceTestConfig in the PerformanceTestResponse. See the responseTimeThreshold value for the required response time in the sandbox environment.
Your server needs to pass the performance test before you can configure a real-time URL for your Get Retention Message endpoint in the production environment. For more information, see Setting up your Get Retention Message endpoint.
HTTP Body
The request body which specifies a transaction identifier of an In-App Purchase to use for this test.