Feasibility Project API
This API is used to determine the feasibility of submitting a project to our panel. This API differs from the feasibility API (above) by using the project's parameters (IR, LOI, datapoints, etc.) to calculate feasibility and the rate card CPI.
Command
"client/feasibilityProject/1"
Inputs
The following values are expected in the JSON body:
Name | Type | Required | Description |
---|---|---|---|
command | String | Must be "client/feasibilityProject/1" |
|
rfg_id | String | The identifier of the project |
Outputs
The JSON output will always contain the original command and a result. If the result > 0, an error has occurred (refer to Error Codes) and a message field will describe the error. If result = 0, the following is included in the response field:
Name | Type | Description |
---|---|---|
feasibility | Object[] | Array of all combinations of datapoint values with its feasibility count. |
cpi | String | The calculated CPI based on customer's rate card in USD. |
Example Command
{
command: "client/feasibility/1",
rfg_id : "RFG12345-001"
}
Example Response
"response" : {
cpi: "$2.65",,
"feasibility" : [
{ "Age" : "Range 24 - 37" , "Gender" : 2 , "Region (UK)" : 4 , "count" : 9.7} ,
{ "Age" : "Range 24 - 37" , "Gender" : 1 , "Region (UK)" : 4 , "count" : 15.9},
{ "Age" : "Range 24 - 37" , "Gender" : 1 , "Region (UK)" : 3 , "count" : 8.5},
{ "Age" : "Range 24 - 37" , "Gender" : 2 , "Region (UK)" : 3 , "count" : 5.6}
]
}