CSA Prediction Engine

The CSA Prediction Engine API is a restful API with various endpoints that return JSON metadata containing relevance-based prediction outcomes and insights.

The CSA Prediction Engine API offers three main prediction endpoints: PSR for standard partial sample regression predictions, MAXFIT for better accuracy, and GRID for the highest optimization and precision.

  • GRID identifies the optimal combination of observations and predictive variables for each prediction task.

  • MAXFIT optimizes prediction accuracy by finding the combination of model parameters that yield the best (adjusted) fit.

  • PSR calculates the partial sample regression model.

Base URL

The base address of the CSA Prediction Engine API is:

https://api.csanalytics.io/v2/prediction_engine/

Authentication

All requests to the CSA Prediction Engine API require authentication. The following describes the required tokens and api keys needed to use CSA's Prediction Engine API.

These IDs are provided by your CSA account manager.

Variable
Where
Description

API_KEY

"x-api-key" (Header)

User organization's API Key

ACCESS_ID

"access_id" (Body)

Individual user's access ID

Requests

Data resources are accessed via standard HTTP requests in UTF-8 format to an API endpoint. The CSA Prediction Engine uses the following HTTP verbs:

Method
Action

GET

Retrieves resources or data

POST

Sends data or actions

Responses

The CSA Prediction Engine uses the following response status codes, as defined in the RFC 2616 and RFC 6585.

All responses contain a JSON object. Properties for these responses are described for each relevant endpoint method.

HTTPS, SSL, and TLS

The CSA Prediction Engine requires HTTPS, SSL, and TLS v1.2 or above. Stay safe and secure.

Last updated