GitHub PullRequestReviewCommentEvent at 2014-05-05 14:30:40
Repository: edx-platform
Actor: mhoeber
Payload: {"comment":{"url":"https://api.github.com/repos/edx/edx-platform/pulls/comments/12280985","id":12280985,"diff_hunk":"@@ -139,49 +139,126 @@ If you use a JSON formatter to \"pretty print\" this event, a version that is more\n Common Fields\n ********************\n \n-This section contains a table of the JSON fields that are common to the schema definitions of all events.\n-\n-+---------------------------+-------------------------------------------------------------+-------------+------------------------------------+\n-| Field                     | Details                                                     | Type        | Values/Format/Member Fields        |\n-+===========================+=============================================================+=============+====================================+\n-| ``agent``                 | Browser agent string of the user who triggered the event.   | string      |                                    |\n-+---------------------------+-------------------------------------------------------------+-------------+------------------------------------+\n-| ``context``               | For all event types, identifies the course that generated   | string/JSON | Contains these common member       |\n-|                           | the event, the organization that lists the course, and the  |             | fields:                            |  \n-|                           | individual who is performing the action.                    |             | ``course_id``                      |\n-|                           |                                                             |             | ``org_id``                         |\n-|                           | ``course_user_tags`` contains a dictionary with the key(s)  |             | ``user_id``                        |\n-|                           |  and value(s) from the ``user_api_usercoursetag`` table     |             | ``course_user_tags``               |    \n-|                           |  for the user. See :ref:`user_api_usercoursetag`.           |             |                                    | \n-|                           |                                                             |             | These fields are blank if values   |\n-|                           | Also contains member fields that apply to specific event    |             | cannot be determined.              |\n-|                           | types only: see the description for each event type.        |             |                                    |\n-|                           |                                                             |             |                                    |\n-|                           | **History**: Added 23 Oct 2013; ``user_id`` added           |             |                                    |\n-|                           | 6 Nov 2013. Other event fields may duplicate this data.     |             |                                    |\n-|                           | ``course_user_tags`` added 12 Mar 2014.                     |             |                                    |\n-+---------------------------+-------------------------------------------------------------+-------------+------------------------------------+\n-| ``event``                 | Specifics of the triggered event.                           | string/JSON |                                    |\n-+---------------------------+-------------------------------------------------------------+-------------+------------------------------------+\n-| ``event_source``          | Specifies whether the triggered event originated in the     | string      | 'browser', 'server', 'task'        |\n-|                           | browser or on the server.                                   |             |                                    |\n-+---------------------------+-------------------------------------------------------------+-------------+------------------------------------+\n-| ``event_type``            | The type of event triggered. Values depend on               | string      | For descriptions of member fields, |\n-|                           | ``event_source``.                                           |             | see the event type descriptions    |\n-|                           |                                                             |             | that follow.                       |\n-+---------------------------+-------------------------------------------------------------+-------------+------------------------------------+\n-| ``ip``                    | IP address of the user who triggered the event.             | string      |                                    |\n-+---------------------------+-------------------------------------------------------------+-------------+------------------------------------+\n-| ``page``                  | Page user was visiting when the event was fired.            | string      | '$URL'                             |\n-+---------------------------+-------------------------------------------------------------+-------------+------------------------------------+\n-| ``session``               | This key identifies the user's session. May be undefined.   | string      | 32 digits                          |\n-+---------------------------+-------------------------------------------------------------+-------------+------------------------------------+\n-| ``time``                  | Gives the UTC time at which the event was fired.            | string      | 'YYYY-MM-DDThh:mm:ss.xxxxxx'       |\n-+---------------------------+-------------------------------------------------------------+-------------+------------------------------------+\n-| ``username``              | The username of the user who caused the event to fire. This | string      |                                    |\n-|                           | string is empty for anonymous events (i.e., user not logged |             |                                    |\n-|                           | in).                                                        |             |                                    |\n-+---------------------------+-------------------------------------------------------------+-------------+------------------------------------+\n+This section describes the JSON fields that are common to the schema definitions of all events.\n+\n+=====================\n+``agent`` Field\n+=====================\n+\n+**Type:** string\n+\n+**Details:** Browser agent string of the user who triggered the event. \n+\n+.. _context:\n+\n+===================\n+``context`` Field\n+===================\n+\n+**Type:** string/JSON \n+\n+**Details:** For all event types, identifies the course that generated the\n+event, the organization that lists the course, and the individual who is\n+performing the action. ``course_user_tags`` contains a dictionary with the key(s)\n+and value(s) from the ``user_api_usercoursetag`` table\n+for the user. See :ref:`user_api_usercoursetag`. \n+\n+**Values/Format/Member Fields:** Contains these common member fields:\n+\n+* ``course_id``\n+* ``org_id``\n+* ``user_id``\n+* ``course_user_tags``\n+\n+These fields are blank if values cannot be determined. Also contains member\n+fields that apply to specific event types only: see the description for each\n+event type.\n+\n+**History**: Added 23 Oct 2013; ``user_id`` added 6 Nov 2013. Other event fields\n+may duplicate this data. ``course_user_tags`` added 12 Mar 2014.\n+\n+===================\n+``event`` Field\n+===================\n+\n+**Type:** string/JSON\n+\n+**Details:** Specifics of the triggered event. Contains member fields that apply\n+to specific event types only: see the description for each event type.\n+\n+========================\n+``event_source`` Field\n+========================\n+\n+**Type:** string\n+\n+**Details:** Specifies whether the triggered event originated in the browser or\n+on the server.\n+\n+**Values/Format/Member Fields:** 'browser', 'server', or 'task'\n+\n+=====================\n+``event_type`` Field\n+=====================\n+\n+**Type:** string\n+\n+**Details:** The type of event triggered. Values depend on ``event_source``. \n+\n+===================\n+``host`` Field\n+===================\n+\n+**Type:** string\n+\n+**Details:** The site visited by the user, typically courses.edx.org.\n+\n+===================\n+``ip`` Field\n+===================\n+\n+**Type:** string\n+\n+**Details:** IP address of the user who triggered the event. \n+\n+===================\n+``page`` Field\n+===================\n+\n+**Type:** string\n+\n+**Details:** Page user was visiting when the event was fired. \n+\n+**Values/Format/Member Fields:** '$URL'\n+\n+===================\n+``session`` Field\n+===================\n+\n+**Type:** string\n+\n+**Details:** This key identifies the user's session. May be undefined. \n+\n+**Values/Format/Member Fields:** 32 digits \n+\n+===================\n+``time`` Field\n+===================\n+\n+**Type:** string\n+\n+**Details:** Gives the UTC time at which the event was fired.\n+\n+**Values/Format/Member Fields:** 'YYYY-MM-DDThh:mm:ss.xxxxxx'\n+\n+===================\n+``username`` Field\n+===================\n+\n+**Type:** The username of the user who caused the event to fire. This string is\n+empty for anonymous events (i.e., user not logged in).","path":"docs/en_us/data/source/internal_data_formats/tracking_logs.rst","position":164,"original_position":164,"commit_id":"c7623158f969ffeefa81826ba041eda4e3822b83","original_commit_id":"c7623158f969ffeefa81826ba041eda4e3822b83","user":{"login":"mhoeber","id":5607222,"avatar_url":"https://avatars.githubusercontent.com/u/5607222?","gravatar_id":"0299334bd62ba980bf49308851fd3311","url":"https://api.github.com/users/mhoeber","html_url":"https://github.com/mhoeber","followers_url":"https://api.github.com/users/mhoeber/followers","following_url":"https://api.github.com/users/mhoeber/following{/other_user}","gists_url":"https://api.github.com/users/mhoeber/gists{/gist_id}","starred_url":"https://api.github.com/users/mhoeber/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mhoeber/subscriptions","organizations_url":"https://api.github.com/users/mhoeber/orgs","repos_url":"https://api.github.com/users/mhoeber/repos","events_url":"https://api.github.com/users/mhoeber/events{/privacy}","received_events_url":"https://api.github.com/users/mhoeber/received_events","type":"User","site_admin":false},"body":"no latin please:)  This string is empty when the user is not logged in.","created_at":"2014-05-05T14:30:40Z","updated_at":"2014-05-05T14:30:40Z","html_url":"https://github.com/edx/edx-platform/pull/3588#discussion_r12280985","pull_request_url":"https://api.github.com/repos/edx/edx-platform/pulls/3588","_links":{"self":{"href":"https://api.github.com/repos/edx/edx-platform/pulls/comments/12280985"},"html":{"href":"https://github.com/edx/edx-platform/pull/3588#discussion_r12280985"},"pull_request":{"href":"https://api.github.com/repos/edx/edx-platform/pulls/3588"}}}}