Forecasting REST API FAQ

What is the Forecasting REST API and how is it used?

The Forecasting API forecasts an individual student or group performance on an upcoming assessment. To accomplish this, the API uses a proprietary growth model, prior information about a student or group of students, and information about an examination to be taken in the future.

What is the difference between the Forecasting REST API and the Forecasting XML-RPC API?

In December of 2020, MetaMetrics released a new REST-based Forecasting API. Both APIs serve the same purpose and functionality; to forecast an individual student or group performance on an upcoming assessment. Migrating to REST improves security, is more consistent with industry standards, provides more comprehensive documentation, helps with support, and is simpler and more efficient for your technical staff to use. The XML-RPC API will be sunsetted in the summer of 2022. Existing XML-RPC users will need to migrate to the REST version before then. New users will only use the REST version.

Do I need to install or manage any software for the Forecasting REST API?

The Forecasting API is a MetaMetrics-managed web service. Clients using the service are not required to install or manage anything. MetaMetrics provides highly available and scalable services using Amazon Web Services (AWS) in geographically-diverse data centers.

What kinds of calls are supported by the Forecasting REST API?

There are two different types of API calls supported by the Forecasting API. The first type forecasts an individual student performance on an upcoming assessment. The second type forecasts a group's performance on an upcoming assessment.

How do I report Forecasting REST API measures?

If the measures are being used for research or institutional purposes, they can be used as reported. If the measures are used for reporting to teachers, parents, and students, then proper branding needs to be applied. See Reporting Scoring Service Measures for specific information on reporting measures.

What kind of performance can I expect out of the Forecasting REST API?

See Service Level Agreement for Scoring Service API for performance commitments, problem reporting and escalation, maintenance information, and more.