Skip to content

Latest commit

 

History

History
282 lines (244 loc) · 8.23 KB

File metadata and controls

282 lines (244 loc) · 8.23 KB

log


GET

POST


GET

Gets a collection of interaction log records.

allIds

Retrieves a list of study IDs found in the current log or a list of the tasks and sessions IDs of the log records for a specific study.

Query String parameters

  • allIds[studyId]=[*|studyId] command

Remarks

None

Example

<hostpath>/log.php?allIds[studyId]=*

Returns the following response that lists the IDs of the study configurations in the database.

{
    "data": {
        "count": 4,
        "studyIds": [
            "1234",
            "2525",
            "1999",
            "2001"
        ]
    }
}
<hostpath>/log.php?allIds[studyId]=1234

Returns the following response that lists the sessions and tasks of study ID: 1234 with log records.

{
    "data": {
        "studyId": "1234",
        "count": 5,
        "sessionIds": {
            "1383605381": [
                "1"
            ],
            "1383623854": [
                "1"
            ],
            "1384302649": [
                "1",
                "2",
                "3"
            ],
            "1384303365": [
                "1",
                "2",
                "3"
            ],
            "1384304762": [
                "1",
                "2",
                "3"
            ]
        }
    }
}
Data field Description
count The number of study or session IDs returned
studyIds An array of all study IDs with log records
studyId The study for which a list of sessions are returned
sessionIds an array of the tasks for the study that have records in the log. In each session entry is an array of the tasks from that session that have records in the log.

studyId or sessionId

The query parameters identify the log records to return in the response buffer.

Either:

  • studyId - the studyId for which all sessions and tasks are returned

OR

  • sessionId - the sessionId of the session (required)
  • taskId - the taskId of the task (optional)

Remarks

If the taskId is 0 or not specified, the interaction log records for all tasks are returned, grouped by taskId.

Response buffer

This is the URL to request the interaction log for all tasks in a session.

<hostpath>/log.php?sessionId=1377486566

Which returns this response buffer.

{
    "data": {
        "1": [
            {
                "serverTimestamp": "2013-08-25 20:10:01",
                "clientTimestamp": "1377486595595",
                "recordType": "open",
                "sessionId": "1377486566",
                "taskId": "1",
                "conditionId": "1",
                "fromUrl": "http://students.washington.edu/rbwatson/hearts.html",
                "toUrl": null,
                "linkClass": null,
                "linkId": null,
                "linkTag": null
            },
            {
                "serverTimestamp": "2013-08-25 20:10:03",
                "clientTimestamp": "1377486597654",
                "recordType": "transition",
                "sessionId": "1377486566",
                "taskId": "1",
                "conditionId": "1",
                "fromUrl": "http://students.washington.edu/rbwatson/hearts.html",
                "toUrl": "http://students.washington.edu/rbwatson/hearts.html#l1",
                "linkClass": null,
                "linkId": null,
                "linkTag": null
            }
        ],
        "2": [
            {
                "serverTimestamp": "2013-08-25 20:10:09",
                "clientTimestamp": "1377486603871",
                "recordType": "open",
                "sessionId": "1377486566",
                "taskId": "2",
                "conditionId": "1",
                "fromUrl": "http://students.washington.edu/rbwatson/spades.html",
                "toUrl": null,
                "linkClass": null,
                "linkId": null,
                "linkTag": null
            },
            {
                "serverTimestamp": "2013-08-25 20:10:10",
                "clientTimestamp": "1377486604881",
                "recordType": "transition",
                "sessionId": "1377486566",
                "taskId": "2",
                "conditionId": "1",
                "fromUrl": "http://students.washington.edu/rbwatson/spades.html",
                "toUrl": "http://students.washington.edu/rbwatson/spades.html#la",
                "linkClass": "menulink",
                "linkId": "menu1a",
                "linkTag": null
            }
        ]
    }
}

This is the URL to request the interaction log for a specific task in a session.

<hostpath>/log.php?sessionId=1377486566&taskId=2

Which returns this response buffer.

{
    "data": [
        {
            "serverTimestamp": "2013-08-25 20:10:09",
            "clientTimestamp": "1377486603871",
            "recordType": "open",
            "sessionId": "1377486566",
            "taskId": "2",
            "conditionId": "1",
            "fromUrl": "http://students.washington.edu/rbwatson/spades.html",
            "toUrl": null,
            "linkClass": null,
            "linkId": null,
            "linkTag": null
        },
        {
            "serverTimestamp": "2013-08-25 20:10:10",
            "clientTimestamp": "1377486604881",
            "recordType": "transition",
            "sessionId": "1377486566",
            "taskId": "2",
            "conditionId": "1",
            "fromUrl": "http://students.washington.edu/rbwatson/spades.html",
            "toUrl": "http://students.washington.edu/rbwatson/spades.html#la",
            "linkClass": "menulink",
            "linkId": "menu1a",
            "linkTag": null
        }
    ]
}

POST

The POST cammands record transaction events in the interaction log.

open

The Open log entry is called to record when a new page is opened.

Data field Description
clientTimestamp The JavaScript formatted timestamp taken from the client browser.
sessionId The session ID for the current session - received from WebLabUX in the study config data.
taskId the current task in the current session (currently this always 1).
conditionId The condition ID for the current session - received from WebLabUX in the study config data.
fromUrl The URL of the page from which the call was made (i.e the page that was just opened.

Response buffer

Sample Open request data block:

{
  "open": {
    "clientTimestamp": 1375043148,
    "sessionId": 12345,
    "taskId": 1,
    "conditionId": 2,
    "pageUrl": "http://students.washington.edu/rbwatson/hearts.html"
  }
}

transition

A transition log entry is used to log when a link is clicked that will navigate to another location (either within the page or in another page).

Data field Description
clientTimestamp The JavaScript formatted timestamp taken from the client browser.
sessionId The session ID for the current session - received from WebLabUX in the study config data.
taskId the current task in the current session (currently this always 1).
conditionId The condition ID for the current session - received from WebLabUX in the study config data.
fromUrl The URL of the page that contains the link that was clicked.
toUrl The URL of the link target (destination) page.
linkClass The value of the class attribute of the link, if one is defined.
linkId The value of the id attribute of the link, if one is defined.
linkTag Reserved.

Response buffer

Sample Transition request data block:

{
  "transition": {
    "clientTimestamp": 1375043148,
    "sessionId": 12345,
    "taskId": 1,
    "conditionId": 2,
    "fromUrl": "http://students.washington.edu/rbwatson/hearts.html",
    "toUrl": "http://students.washington.edu/rbwatson/spades.html",
    "linkClass": "a_class",
    "linkId": "a_Id",
    "linkTag": "a"
  }
}