Extract Assessment Data

Overview Post the Request Check Status Reset & Reuse

Overview

The Assessment Data API allows you to request, monitor, and download assessment report data. The workflow follows a three-step pattern: post a request to create a job, poll the job status until it completes, and download the output file from the provided URL.

What you can do

✓Post an assessment data request and receive a requestId to track the job

✓Check the status of a job using its requestId and download the output file when complete

✓Reset a completed request to trigger a new extraction without creating a new job

Step 1 — Post the Request

To initiate an assessment data extraction, POST a JSON request body containing three fields:

requestNameA unique name to identify the request or job in the system.

requestTypeIdentifies the type of report to generate. See the table below for accepted values.

requestParamsAdditional parameters for the request.

Request Types

requestType	Description
ASSESSMENT_SUMMARY	Contains summary data, comments, and tasks for assessments
ASSESSMENT_SURVEY	Contains survey data, comments, and tasks for each survey within an assessment
ASSESSMENT_SURVEY_WITH_SUMMARY	Combines both ASSESSMENT_SUMMARY and ASSESSMENT_SURVEY data in a single report

📋 Note: The requestName must be unique within the system to identify the job. Reusing an existing requestName may cause conflicts.

Step 2 — Check Request Status

Once the request is posted, the API returns a requestId that uniquely identifies the job. Use this ID to poll the request status. Possible status values are:

PENDINGThe job has been queued and is waiting to start.

RUNNINGThe job is currently in progress.

OKThe job completed successfully. The response includes one or more download URLs for the output file. Download links are active for 15 minutes. After that, query the status again to receive a new link.

ERRORThe job completed with an error. Review the error details in the response before retrying.

📋 Note: OK and ERROR are terminal statuses — they indicate the job has finished. Refer to the Appendix section for details on the output file format.

Step 3 — Reset and Reuse the Request

Once a job has completed, you can reset the request to trigger a new extraction without creating a new job. Resetting allows you to reuse the same requestName and configuration for subsequent data pulls.

TrustArc  ·  Assessment Data API  ·  support.trustarc.com