Events
Information for all Events
Name | Type | Description | Examples |
---|---|---|---|
eventId | character | Event ID | |
periodTime | double | Timestamp of the event within the period | |
periodNumber | integer | Period Number of the event (99 is the Penalty Shootout) | |
playerId | character | Player ID | |
teamId | character | Team ID | |
eventName | character | Name of the event (see Details for further description) | |
locationX | double | Lengthwise coordinate of the event in ft, center FO dot as origin (0, 0) | |
locationY | double | Crosswise coordinate of the event in ft, center FO dot as origin (0, 0) | |
matchId | character | Match ID | |
homeStrengthState | character | Strength State from the perspective of the home team given in Home Skaters x Away Skaters format (e.g. 5x5, 5x4, etc.) | |
homeStrengthSituation | character | Strength Situation given from the perspective of the home team (ES, PP, PK) | |
homeSkaters | list | List of player IDs of On-Ice skaters for the home team | |
awaySkaters | list | List of player IDs of On-Ice skaters for the away team | |
homeGoalie | character | Player ID of the home team’s goalie if in the net. | |
awayGoalie | character | Player ID of the away team’s goalie if in the net. | |
zone | character | Zone where the event occured | dz, nz, oz |
eventOutcome | character | Outcome of the Event (see Details for options by event) | |
teamName | character | Event Team’s Name | |
playerJersey | integer | Jersey Number of the main player of the event | |
playerPosition | character | Position of the main player of the event | |
playerFirstName | character | First name of the main player of the event | |
playerLastName | character | Last name of the main player of the event | |
eventType | character | Additional information about the event (see Details for options by event) | |
eventDetails | list | Further listed details about the event (see Details for options by event) |
Faceoff
Faceoffs are always returned from the perspective of the faceoff winner. I.e. if the home team wins a DZ faceoff it is a DZ win for the home team, if the away wins an OZ win it is an OZ win for the away team.
Name | Type | Description | Examples |
---|---|---|---|
eventOutcome | character | W | |
eventType | character | Zone from the perspective of the faceoff winner | dz, nz, oz |
winner | character | Player ID of the player winning the faceoff | |
loser | character | Player ID of the player losing the faceoff |
eventDetails
Name | Type | Description | Examples |
---|---|---|---|
winner | character | Player ID of the player winning the faceoff | |
loser | character | Player ID of the player losing the faceoff |
Recovery
Attempted Recovery of a loose puck.
Name | Type | Description | Examples |
---|---|---|---|
eventOutcome | character | Success of the attempted puck recovery. Success means the Player ended up with possession of the puck. | successful, failed |
eventType | character | Situation of the puck recovery attempt | faceoff, dump, rebound, other |
Pass
The location and player playing the pass. If the pass was played to its intended target in a way that a successful reception should have been possible, a reception event is generated. If the pass was not played in a way that a reception was possible, a target event is generated. They are connected via the receptionId (in pass events) and passId (in target and reception events) eventDetail entries that match the event IDs of the two connected events to one another.
Name | Type | Description | Examples |
---|---|---|---|
eventOutcome | character | Success of the attempted pass. Success means the pass was completed to its intended target. | successful, failed |
eventType | character | Zone where the pass was taken from with special entries for zone entry passes (ozentry) and zone exit passes (dzexit) | ozentry, dzexit, dz, nz, oz |
eventDetails
Name | Type | Description | Examples |
---|---|---|---|
boards | character | Detail on whether the pass was played to a teammate via the boards, rimmed around the corner or played directly without going off the boards. | Boards, Rim, Direct |
icing | logical | Whether or not the pass resulted in a called icing | TRUE, FALSE |
receptionId | character | Event ID of the target/reception event connected to this pass. To help quickly access the player and location targeted by the pass. | |
entryDId | character | Event ID of the entry defense event connected to a zone entry. To help quickly access the player and location of the player defending the zone entry. |
Reception
The location and player trying to receive a pass from a teammate. In cases where the pass was played in a way that a reception would not have been possible, a target event is generated instead. Each reception is connected to a single pass event via the passId event detail.
Name | Type | Description | Examples |
---|---|---|---|
eventOutcome | character | Success of the attempted reception. Success means the pass was completed to its intended target. Failure means the pass was on target but the player failed to properly control the pass. | successful, failed |
eventType | character | Zone where the reception was attempted with special entries for zone entry passes (ozentry) and zone exit passes (dzexit). | ozentry, dzexit, dz, nz, oz |
eventDetails
Name | Type | Description | Examples |
---|---|---|---|
passId | character | Event ID of the pass event connected to this reception. To help quickly access the player and location where the pass originated. |
Target
The location and player targeted by a pass that was not able to be received (either because the pass is deflected or because it was deflected/intercepted, etc.). In cases where the pass was played in a way that a reception would have been possible, a target event is generated instead. Each target is connected to a single pass event via the passId event detail.
Name | Type | Description | Examples |
---|---|---|---|
eventOutcome | character | Not in use | none |
eventType | character | Zone where the reception was attempted with special entries for zone entry passes (ozentry) and zone exit passes (dzexit). | ozentry, dzexit, dz, nz, oz |
eventDetails
Name | Type | Description | Examples |
---|---|---|---|
passId | character | Event ID of the pass event connected to this pass target. To help quickly access the player and location where the pass originated. |
Shot
Shot Attempt taken by a player.
Name | Type | Description | Examples |
---|---|---|---|
eventOutcome | character | Outcome of the shot. | blocked, missed, on_goal, goal |
eventType | character | Type of shot taken. | wristshot, snapshot, deflection, slapshot, backhand, wrap_around, fan, other |
eventDetails
Name | Type | Description | Examples |
---|---|---|---|
traffic | logical | Event ID of the pass event connected to this pass target. To help quickly access the player and location where the pass originated. | |
oneTimer | logical | Event ID of the pass event connected to this pass target. To help quickly access the player and location where the pass originated. | |
blockingPlayerId | character | Only applies to blocked shots. Player ID of the player blocking the shot. | |
assist1 | character | Only applies to goals. Player ID of the player having given the primary assist. | |
assist2 | character | Only applies to goals. Player ID of the player having given the secondary assist. |
Puck Protection
Attempt by a player to protect their own possession of the puck from an opponent either by deking or using their body position.
Name | Type | Description | Examples |
---|---|---|---|
eventOutcome | character | Outcome of the puck protection attempt. | successful, failed |
eventType | character | Whether the player tried to deke past his opponent or put his body between the opponent and the puck. | deke, body |
eventDetails
Name | Type | Description | Examples |
---|---|---|---|
defender | character | Player ID of the player trying to defend against the player attempting the puck protection. | |
icing | logical | Whether or not the pass resulted in a called icing | TRUE, FALSE |
Dumpin
Attempt to dump the puck into the opponent’s zone.
Name | Type | Description | Examples |
---|---|---|---|
eventOutcome | character | Outcome of the dumpin. A failed dumpin is tracked if the dumpin does not “go deep”, i.e. does not reach beyond the start of the faceoff circles in the offensive zone. | successful, failed |
eventType | character | Whether the puck was chipped past a defender off the boards (chip), tipped in off a hard pass (tip), flipped over the defenders (flip), shot near the goal (shot) or dumped in regularly (dump). | chip, tip, flip, dump, shot |
eventDetails
Name | Type | Description | Examples |
---|---|---|---|
direction | character | Where the dumpin was placed in the zone | crossice, rim, straight |
icing | logical | Whether or not the pass resulted in a called icing | TRUE, FALSE |
entryDId | character | Event ID of the entry defense event connected to a zone entry. To help quickly access the player and location of the player defending the zone entry. | |
recoveryId | character | Event ID of the puck recovery following the dumpin. To help quickly access the player and location where the dumpin was recovered. |
Dumpout
Attempt to dump the puck out of a player’s own defensive zone.
Name | Type | Description | Examples |
---|---|---|---|
eventOutcome | character | Outcome of the dumpout. A failed dumpout is tracked if the dumpout does not “clear the zone”, i.e. does not leave the defensive zone. | successful, failed |
eventType | character | Whether the puck was chipped or rimmed around the boards (boards), flipped over the forecheckers (flip) or dumped out in other ways (other). | boards, flip, other |
eventDetails
Name | Type | Description | Examples |
---|---|---|---|
icing | logical | Whether or not the pass resulted in a called icing | TRUE, FALSE |
recoveryId | character | Event ID of the puck recovery following the dumpin. To help quickly access the player and location where the dumpin was recovered. |
Carry
Attempt to carry the puck over either blue line or over the red center line.
Name | Type | Description | Examples |
---|---|---|---|
eventOutcome | character | Outcome of the carry. Losing possession while carrying the puck across the line counts as a failed carry. | successful, failed |
eventType | character | Whether the puck was carried across one’s own blue line (dzexit), carried across the red line (redline) or carried across the opponent’s blue line (ozentry). | dzexit, redline, ozentry |
entryDId | character | Event ID of the entry defense event connected to a zone entry. To help quickly access the player and location of the player defending the zone entry. |
eventDetails
Name | Type | Description | Examples |
---|---|---|---|
entryDId | character | Event ID of the entry defense event connected to a zone entry. To help quickly access the player and location of the player defending the zone entry. |
Entry D
Identifying the player defending the blue line against a zone entry attempt by the opponent. The player is always classified as the closest player to the player attempting the zone entry.
Name | Type | Description | Examples |
---|---|---|---|
eventOutcome | character | Not in use | none |
eventType | character | Whether the zone entry was attempted by carrying the puck across the blue line (carry), passing the puck across the blue line (pass) or dumping the puck in (dump). | carry, dump, pass |
eventDetails
Name | Type | Description | Examples |
---|---|---|---|
entryId | character | Event ID of the entry event connected to the zone entry defense. To help quickly access the player and location of the player attempting the zone entry. | |
rushNo | character | Rush situation when the zone entry occurs from the perspective of the attackers, i.e. 3x1 is a 3 on 1 rush for the attackers. | 3x2, 2x2, etc. |
Battle
Extended battle between multiple players for possession of the puck. Success is given to the team that ended up with possession of the puck.
Name | Type | Description | Examples |
---|---|---|---|
eventOutcome | character | Not in use | none |
eventDetails
Name | Type | Description | Examples |
---|---|---|---|
winningPlayers | character | Player IDs of the players involved in the puck battle for the team that won possession of the puck. | |
losingPlayers | character | Player IDs of the players involved in the puck battle for the team that did not win possession of the puck. |
Controlled Breakout
Identifier marking the start of a set or controlled breakout, usually played against a trapping opponent.
Name | Type | Description | Examples |
---|---|---|---|
eventOutcome | character | Not in use | none |
Penalty
Penalty taken by a player.
Name | Type | Description | Examples |
---|---|---|---|
eventOutcome | character | Not in use | none |
eventType | character | Type of penalty (major, minor, etc.) | Major, Minor, GameMisconduct, DoubleMinor, PenaltyShot |