<!--
{
  "availability" : [
    "Retention Messaging API: 1.3.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "RetentionMessaging",
  "identifier" : "/documentation/RetentionMessaging/Initiate-Performance-Test",
  "metadataVersion" : "0.1.0",
  "role" : "Web Service Endpoint",
  "symbol" : {
    "kind" : "Web Service Endpoint",
    "modules" : [
      "Retention Messaging API"
    ],
    "preciseIdentifier" : "rest:retention_messaging:post:inApps-v1-messaging-performanceTest"
  },
  "title" : "Initiate Performance Test"
}
-->

# Initiate Performance Test

Initiates a performance test of your Get Retention Message endpoint in the sandbox environment.

## 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`](/documentation/RetentionMessaging/PerformanceTestConfig) object that describes the testing parameters and a `requestId` you can use to request test results.

> Note: The performance test runs only in the sandbox environment. Use original transaction identifiers of transactions you initiate in the sandbox environment. For more information, see ``doc://com.apple.retentionmessaging/documentation/RetentionMessaging/PerformanceTestRequest``.

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`](/documentation/RetentionMessaging/PerformanceTestConfig) in the [`PerformanceTestResponse`](/documentation/RetentionMessaging/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](/documentation/RetentionMessaging/setting-up-retention-messaging-endpoint).

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)