Project Statistics API

This API is used to obtain the latest statistics on project performance.

Command

"client/projectStatistics/1"



Inputs

The following values are expected in the JSON body:

Name Type Required Description
command String

Must be "client/projectStatistics/1"
rfg_id String

The identifier of the project
completesByCPI Boolean

Set this to true to include a breakdown of completes by their CPI.

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
starts Integer

Number of respondents sent into the project.
completes Integer

Number of respondents that have completed the survey.
terminates Integer

Number of respondents that have been rejected from the survey.
overQuotaa Integer

Number of respondents that have been rejected because the quota was full.
cr Integer

Conversion rate as a percent.
ir Integer

Incidence rate as a percent.
acceptedCompletes Integer

For closed/billed projects.
quotas Object[]

Stats for quotas.
medianLOI Integer

The actual median length of interview in minutes.
completesByCPI Object[]

A list of completes separated by CPI. Only included if completesByCPI was set to true.


Example Response

response : {
     starts : 100,
     completes : 20,
     terminates : 30,
     overQuotas : 0,
     cr : 25,
     ir: 37,
     quotas:[
          {
               id: "RFG12345-001- q1",
               starts : 10,
               completes : 2,
               terminates : 3,
               overQuotas : 0
          },
          {
               id: "RFG12345-001- q2",
               starts : 90,
               completes : 18,
               terminates : 27,
               overQuotas : 0
          }
     ]
}