Project Log API

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

Command

"livealert/log/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/log/1"
rfg_id String

The identifier of the project.
result Integer

Optional filter to show only log entries with the given result.
start Date

Optional date range. If no end date is specified, all the sessions that started after the specified "start" will be returned.
end Date

Optional date range. Together with "start", "end" defines a specific range of time for obtaining only entries within that range. If "start" is not specified, "end" is ignored.

Outputs

Name Type Description
log JSON[]

JSON array of log entry objects where each entry includes:

Key Value
sesskey RFG sesskey (unique id for session).
start start time
end End time
result Result
The result will be one of:
1. Complete
2. Terminate
3. Quota
4. Other
5. Closed
// No #6, was previously 'RFG Security'
7. Early Terminate
8. Duplicate
9. Early Quota
10. Customer Security
11. No Survey Found
12. All Surveys Attempted
13. Max Tries Reached
(Integers 14 - 18 are for internal use and are omitted from this list on purpose)
19. Paused
20. In Screener (will not be reported on a callback URL. Visible in Live Alert Log API)
21. Drop In Screener (will not be reported on a callback URL. Visible in Live Alert Log API)
22. In Survey (will not be reported on a callback URL. Visible in Live Alert Log API)
23. Drop In Survey (will not be reported on a callback URL. Visible in Live Alert Log API)
// RFG Security pre-survey
30. Max Mind Fraud
31. IP Invalid
32. IP Blacklist
33. Zip Distance (the panelist was more than 600miles away from what their postalCode stated)
34. Blocked Panelist
35. Country Change
36. Country Mismatch
37. Birthdate Invalid
38. Too Young
39. Age Mismatch
40. Gender Invalid
41. Postal Code Invalid
42. Unauthorized OS
43. RFG Turing Test Failed
44. Robot Test Failed
// RFG Security post-survey
50. Speeding
51. Hash Invalid
52. Client IP Whitelist Failure (Some of our clients use IP whitelisting and this result is used for a scenario where we received a callback from an IP not present in the whitelist for that customer)
53. Customer Turing Test Failed (Some of our client's have turing tests in their flow. This result will be received when a user fails a turing test)
loi LOI
* your tracking Ids.


Example Response

For example, if your tracking ids are "rid" and "trackerId":

"log": [
    {
        "start" : "2014-08-03T11:37:49" ,
        "end" : "2014-08-03T11:37:55" ,
        "result" : 3 ,
        "loi" : 6 ,
        "sesskey" : "53de02ede4b0115crf372867",
        "rid":"wer34",
        "trackerId":"fdsfjk23"
    },
    {...}, 
    {...}
]