Skip to main content
POST
Calculate the maximum number of credits needed for a respondent
If you need to estimate the number of credits required to add a respondent, you can use this endpoint.
This endpoint is optional and serves informational purposes only. It provides an estimate of the credits required based on the selected quality scores.
DESDataPoints is optional and defaults to 0 if omitted.

Authorizations

api-key
string
header
required

Body

application/json

Request body for calculating the maximum number of credits needed for a respondent. Send exactly one of GQSDataPoints or GQSAnswers. Sending both returns 400.

🔒 Authentication: Requires a private API key. Public keys may only call addRespondent.

OESDataPoints
number
required

The number of data points to be used for the Open-Ended Score (OES). ⭕ Note: If no OES data points are available, this value can be set to 0.

TSDataPoints
number
required

The number of data points to be used for the Time Score (TS). ⭕ Note: If no TS data points are available, this value can be set to 0.

CHSAnswers
number
required

The number of data points to be used for the Coherence Score (CHS). ⭕ Note: If no CHS answers are available, this value can be set to 0.

BASDataPoints
number
required

The number of data points to be used for the Behavioral-Analytics Score (BAS). ⭕ Note: If no BAS data points are available, this value can be set to 0.

GQSDataPoints
number

The number of GQS data points to price. Modular: min(0.2 × n, 2). All-inclusive: min(0.2 × max(0, n − 5), 2). Send this or GQSAnswers, not both.

GQSAnswers
number

Legacy alias for GQS. Deprecated; prefer GQSDataPoints. Send this or GQSDataPoints, not both.

DESDataPoints
number
default:0

The number of data points to be used for the Duplicate Entrance Score (DES). Optional; defaults to 0 if omitted. ⭕ Note: If no DES data points are available, this value can be omitted or set to 0.

Response

When a request is successfully processed, the API returns a 200 OK status code along with the expected data.

success
enum<boolean>

A variable indicating whether the operation was successful.

Available options:
true,
false
message
string

A variable that human-readable message providing additional context or confirmation of the requested action.

results
object

This object serves as a container to hold the results for the requested data, encapsulating all relevant information and outputs in a structured format.