Search

Extract Assessment Data

Users can use following APIs to request Assessment Data.

  • Post the request.

    The JSON request contains 3 main fields: requestName, requestType, and requestParams. The requestName must be unique to identify the request or job in our system. The requestType has 3 possible types to identify type of report.

    RequestTypeDescription
    ASSESSMENT_SUMMARYContains summary data, comments & tasks of assessments
    ASSESSMENT_SURVEYContains survey, comments & tasks of each survey of assessments
    ASSESSMENT_SURVEY_WITH_SUMMARYCombines both SUMMARY & SURVEY
  • The request returns the requestId to identify the specific job.
  • Check for request status.

    User can check the status of request using requestId. The status of request can be: PENDING, RUNNING, OK, ERROR.

    OK and ERROR indicates the final status of completed job. If status is OK, user will receive one of more URLs for the output file to download. Link will be active for 15 minutes to download. After 15 minutes, user would have to query the status again to get a new download link.

    Refer to the Appendix section for the format of the report file.
     
  • User can re-use the request by resetting to ask for new extraction again.