Get player usage report
The Nintendo Switch parental controls: Get player usage report action retrieves which Nintendo applications one player has used today on a specified Nintendo Switch device, and for how long.
This action returns response data containing the player’s application usage. To get the usage of every player on the device at once, use Get device usage report.
This action does not support targets. In the UI, you are not prompted to choose an area, entity, or label. Instead, you select the Nintendo Switch through the Device option and the player through the Player option.
Using this action from the user interface
If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.
To retrieve a player usage report from an automation or a script:
- Go to Settings > Automations & scenes.
- Open an existing automation or script, or select Create automation > Create new automation.
- If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
- In the Then do section, select Add action.
- From the search box, search for and select Nintendo Switch parental controls: Get player usage report.
- Choose the Device.
- Under Player, choose the player’s screen time sensor, for example Alex used screen time.
- In the Response variable field, enter a name to store the result, for example
player_report. - Select Save.
Options in the UI
Using this action in YAML
If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required. For how an automation or a script is built in YAML, refer to Automations in YAML and Scripts.
In YAML, refer to this action as nintendo_parental_controls.player_usage_report. Because this action returns data, supply a response_variable to capture the output:
action: nintendo_parental_controls.player_usage_report
data:
device_id: 1b4a46c6d0f3406c80d275f5b0c6483b
entity_id: sensor.example_player_used_screen_time
response_variable: player_report
Options in YAML
Response data
The action returns the applications the player has played today. playing_time is in minutes, and whitelisted is true when the application is on the Allow List of the parental controls:
{
"apps": [
{
"name": "Super Mario Odyssey",
"playing_time": 45,
"image": "https://example.com/image.png",
"whitelisted": true
}
]
}
Try it yourself
Ready to test this? Open Settings > Tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.
Still stuck?
To test the action on its own, run it in the automation editor with Run action, and check the message that it shows. To see what the action did when the automation ran, open the trace of that run. For details, refer to Testing automations. For common problems and their solutions, refer to Troubleshooting automations.
If that doesn’t help, the Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.
AI assistants like ChatGPT or Claude can also explain actions or suggest the right one when you describe what you want in plain language.
Related actions
Explore related actions:
-
Get device usage report: Get today’s application usage details for a device.
-
Get player usage report: Get today’s application usage details for one player on a device.