AnalyticsResult API

The result returned by the AnalyticsResult resource is the latest version of a result in Reporting. If any changes have taken place in Reporting, this resource provides the latest result data.

The HistoricalResult resource can be used to retrieve a record of the result in each state between rescoring sessions. For more information, read HistoricalResult API.

The AnalyticsResult API resource is used to list and retrieve results and item responses.

This article explains what calls can be made to the Surpass API using the AnalyticsResult API resource.

Import this API into your Postman Workspace

In This Article

Listing results

get /api/v2/AnalyticsResult

Send a request to the endpoint to retrieve a list of results. Refer to the available parameters to influence the response. No request body is required.

Retrieving result information

get /api/v2/AnalyticsResult/{id}

Send a request to the endpoint to retrieve information for a specific result using either its ID or the candidate’s unique keycode. No request body is required.

Listing item responses

get /api/v2/AnalyticsResult/{id}/ItemResponse

Send a request to the endpoint to retrieve a list of item responses for the specified result. Refer to the available parameters to influence the response. No request body is required.

Retrieving item responses

get /api/v2/AnalyticsResult/{id}/ItemResponse/{surpassReference}

Send a request to the endpoint to retrieve information for the specified item response. Refer to the available parameters to influence the response. No request body is required.

Error Codes

Refer to the following table for information on error codes that may be encountered when using this resource.

Further reading

Read the following articles to learn more about similar APIs, how to get started with the Surpass API v2, and how to get the best out of this reference documentation:

NOTE: This form is to provide feedback to help improve the Surpass Help documentation only. If you need live support, contact support@surpass.com.