Project Statistics API
This API is used to obtain the latest statistics on survey performance.
Command
"livealert/stats/1"
Recommended Frequency
You can use this at a frequency of your choosing.
Inputs
The following values are expected in the JSON body:
Name | Type | Required | Description |
---|---|---|---|
command | String | Must be "livealert/stats/1" |
|
rfg_id | String | The identifier of the project. |
Outputs
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. |
quotas | Integer | Number of respondents where their quota was full. |
cr | Integer | Complete rate considering only your respondents. |
epc | String | Effective cost per click considering only your respondents. |
projectCR | Integer | Complete rate considering all the respondents we have received for this project (not only yours). |
projectEPC | String | Effective cost per click considering all the respondents we have received for this project (not only yours). |
trailingCR | String | Complete rate considering recent project performance (not only yours) |
trailingEPC | String | Effective cost per click considering recent project performance (not only yours) |
Example Response
{
"command" : "livealert/stats/1",
"response" : {
"completes" : 4,
"cr" : 23,
"epc" : "$.49",
"projectCR" : 21,
"projectEPC" : "$.44",
"quotas" : 0,
"starts" : 17,
"terminates" : 13,
"trailingCR" : 19,
"trailingEPC" : "$.40"
},
"result" : 0
}