Test Custom Integrations
To test your custom integrations in a nonproduction environment, use AgentExchange App Analytics Simulation Mode. Submit an App Analytics query request and receive sample usage data.
| User Permissions Needed | |
|---|---|
| To enable simulation mode: | ModifyMetadata |
AgentExchange App Analytics is subject to certain usage restrictions as described in the AgentExchange Program Policies.
To receive sample usage data, enable simulation mode, then submit a query request that includes a simulation mode package ID.
-
Enable simulation mode in your test org using the Metadata API AppAnalyticsSettings
enableSimulationModeorg preference. -
To simulate package usage log, usage summary, or subscriber snapshot downloads, complete the required fields in your SOAP API AppAnalyticsQueryRequest. Include
DataType, and leaveOrganizationIDsblank. ForPackageIDs, include at least one simulation mode package ID that matches the scenario you’re testing.Package Dataset Simulation Mode Package ID Description Small Dataset 033xx00SIMsmallContains a small amount of data. For use with all query types. Use this package ID to download data for any query-allowed timespan. Large Dataset 033xx00SIMlargeContains a large amount of data for two org IDs ( 00Dxx00SIM00fooand00Dxx00SIM00bar). For use only with package usage log queries.Empty Dataset Use any other 15-character package ID prefixed with 033xx00SIM. Examples:033xx00SIMempty033xx00SIM44444
Contains no data. For use with all query types. Use one of these package IDs to return an empty dataset. -
Submit your query.
-
Check your API request.
-
If successful, retrieve the App Analytics Query Request object created in the API request. The
DownloadURLfield populates when the request is completed. -
If you get an error, edit your query. Use a smaller time window, such as a 14 days, or specify one org ID. Then resubmit your query.
-
-
Download the comma-separated value (.csv) file containing sample usage data from the DownloadURL field in the App Analytics Query Request object.
When simulation mode is enabled, you can only access our sample usage data. Disable simulation mode to access your production data.