Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: adds models for video engagement reports (FC-0024) #6

Closed

Conversation

SoryRawyer
Copy link
Contributor

@SoryRawyer SoryRawyer commented Jun 21, 2023

Adds two new models for issue #3 :

  • video_plays: contains a record for each time a learner played a video. Can be used to generate reports of total plays and unique watchers
  • transcript_usage: contains a record for each time a transcript or closed caption was enabled. Can be used to generate reports for total transcription/caption usage as well as the number of unique learners who enabled transcription/closed captioning

For each model, org, course_id, and video_id are available as dimensions.

Question for reviewers: is there a more robust way of deriving a video ID from the object_id? This approach works for test data but uses a relatively naive approach and may not accurately capture the video ID from different environments.

Note: this PR does not define the metrics available from these tables as they also need to be defined in Superset. I have Superset datasets (and an example chart) for each model and can export and share them if that's helpful.

`video_plays` contains a record for each time a learner played a video.
Can be used to generate reports of total plays and unique watchers

`transcript_usage` contains a record for each time a transcript or
closed caption was enabled. Can be used to generate reports for total
transcription/caption usage as well as the number of unique learners who
enabled transcription/closed captioning
@openedx-webhooks
Copy link

Thanks for the pull request, @SoryRawyer! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jun 21, 2023
@bmtcril
Copy link
Contributor

bmtcril commented Jun 22, 2023

Is this going to need to be refactored after the mv changes?

@SoryRawyer
Copy link
Contributor Author

It is, just a little bit. I'll update the PR to reflect the MV changes.

feanil and others added 6 commits June 25, 2023 09:30
The .github/workflows/self-assign-issue.yml workflow is missing or needs an update to stay in
sync with the current standard for this workflow as defined in the
`.github` repo of the `openedx` GitHub org.
The .github/workflows/add-depr-ticket-to-depr-board.yml workflow is missing or needs an update to stay in
sync with the current standard for this workflow as defined in the
`.github` repo of the `openedx` GitHub org.
The .github/workflows/commitlint.yml workflow is missing or needs an update to stay in
sync with the current standard for this workflow as defined in the
`.github` repo of the `openedx` GitHub org.
The .github/workflows/add-remove-label-on-comment.yml workflow is missing or needs an update to stay in
sync with the current standard for this workflow as defined in the
`.github` repo of the `openedx` GitHub org.
@SoryRawyer SoryRawyer force-pushed the init_video_engagement_models branch from 8f4a0d4 to 55d5061 Compare June 25, 2023 13:31
@SoryRawyer
Copy link
Contributor Author

It doesn't look like my rebase worked as I'd expected, so I'm just going to close this PR and open a new one with the same changes.

@SoryRawyer SoryRawyer closed this Jun 25, 2023
@openedx-webhooks
Copy link

@SoryRawyer Even though your pull request wasn’t merged, please take a moment to answer a two question survey so we can improve your experience in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

4 participants