Generate Sample Report

This endpoint is used to simulate a Treefort report for testing or demo purposes. Using this endpoint will generate a sample report with test data for the clientRequestId used in the request, and will also send a response to your webhook (if configured).

Note: this endpoint is only available in the sandbox (UAT) environment.

Response Schema

AttributeTypeDescription
statusCodeIntegerStandard HTTP response code. Status codes are outlined in the Errors section of this API reference.
messageStringA human-readable message providing more details about the status code. Messages are outlined in the Errors section of this API reference.
dataBoolA true or false value indicating if the sample report was successfully generated.
errorsArray of StringsAn array of human-readable error messages, if available (null otherwise). Unique errors associated with this endpoint, if applicable, are shown in the example response in the right column with the corresponding HTTP status code.
Language
Credentials
OAuth2