football-docs 0.6.2 → 0.6.3

package/docs/_reference/skillcorner-crunch-help/getting-started-generate-visual-reports.md

@@ -0,0 +1,90 @@
+---
+source_url: https://skillcorner.crunch.help/en/getting-started/generate-visual-reports
+source_type: crunch_help_kb
+upstream_version:
+crawled_at: 2026-07-13T14:07:00.803Z
+---
+The aim of this page is to present our tool that will help you compare player performances with a visual approach. In fact, the Physical Benchmark Generator allows you to compare the physical output of targeted players to other players of interest and/or to the average output of players playing at a given position(s), in any competition you have access to.
+
+## Accessing the Physical Benchmark Generator
+
+You can access the Physical Benchmark Generator through the dedicated button in the [SkillCorner Web Application header](https://skillcorner.com/app/login) or by directly clicking [here](https://skillcorner.com/app/report).
+
+## Using the Physical Benchmark Generator
+
+**Recommended reading  
+**Before diving into this section, we advise you to have a look to:  
+  
+\- The [definitions](https://skillcorner.crunch.help/en/glossaries/physical-data-glossary) of our Physical metrics  
+
+To use the Physical Benchmark Generator, you need to:
+
+1.  Complete the form to determine which parameters should be included in the report
+2.  Click on the “Generate PowerPoint” Button
+3.  Wait about **2 minutes** for the reports to be generated
+4.  Click on the “Download Report” button to download the PowerPoint Presentation on your computer.
+
+Here is what this will look like from you end, followed by more context regarding the different fields and the end result:
+
+###   
+Completing the form
+
+**Fields** (\* stands for required)
+
+**Description**
+
+**Seasons\***
+
+These are the seasons you are interested in including data.
+
+**Target players\***
+
+The players you are interested in.
+
+**Comparison players**
+
+Other players of interest you want to compare with your target players.
+
+**Benchmark competition editions\***
+
+Performances from players in this competition edition will be used to compute averages so that you can compare your target players’ outputs to these averages.
+
+**Background competition editions\***
+
+Performances from players in these competitions editions will be used for scatter plots to help you visualize the range of possible value for any physical metrics.
+
+**Position Group\***
+
+The reports only take into account the players' matches when they played in the selected position groups.
+
+It applies for the target players, the comparison players but also the benchmark competition edition and the background competition editions.
+
+**Split By\***
+
+Check the team checkbox if (i) there is at least one player in the target and/or comparison players that played in more than one clubs during the seasons you selected and (ii) you want to distinguish his performance in each club.
+
+**Thresholds**
+
+We recommend only generating reports for players that played more than 10 games with a playing time of 60 minutes.
+
+**Player labels**
+
+You can change the label of the player that will appear in the PowerPoint presentation. It can be useful for players with very long names.
+
+### Benchmark report content
+
+The benchmark reports consist of 18 PowerPoint slides including:
+
+-   An overview of the data included in the report 
+-   A glossary
+-   13 plots - 7 scatter plots, 5 bar plots and 1 violin plot - to compare players based on their physical outputs (volume, intensity, speed, etc)
+
+Here are some examples of what the end result will look like:
+
+![](https://ucarecdn.com/d363eeda-410b-4ae2-8582-8268e6d4267f/Capture%20d%E2%80%99e%CC%81cran%202023-06-22%20a%CC%80%2017.45.41.png)_Scatter plot representing the number of accelerations of different players_
+
+![](https://ucarecdn.com/8f4ca21c-e88a-494f-9f7a-65386369744f/Capture%20d%E2%80%99e%CC%81cran%202023-06-22%20a%CC%80%2017.45.53.png)_Bar plot representing the average sprinting distance of different players_
+
+![](https://ucarecdn.com/b72f9929-fa5d-4fa5-a1de-5d4ce52bb5ad/Capture%20d%E2%80%99e%CC%81cran%202023-06-22%20a%CC%80%2017.46.06.png)Violin plot representing the PSV-99 of different players
+
+If you have any questions and/or feedbacks regarding this feature, do not hesitate to [send us an email](mailto:support@skillcorner.com).

package/docs/_reference/skillcorner-crunch-help/getting-started-make-your-first-queries.md

@@ -0,0 +1,92 @@
+---
+source_url: https://skillcorner.crunch.help/en/getting-started/make-your-first-queries
+source_type: crunch_help_kb
+upstream_version:
+crawled_at: 2026-07-13T14:06:52.784Z
+---
+The aim of this page is to give you an overview of the requests available and guide you through your first steps.
+
+The SkillCorner [Web app](https://skillcorner.com/app/login) provides users with an interface to query the data which is stored in our database.  
+Using the tool, you can then extract CSV format data based on specific selections, filters and reports.
+
+## Web App Organization
+
+We currently offer two data packages that you will find in separate sections:
+
+-   Physical metrics ([learn more here](https://skillcorner.crunch.help/en/glossaries#physical)).
+-   In-possession data; focusing on off-ball runs, passes and on-ball pressure aggregates ([more details here](https://skillcorner.crunch.help/en/glossaries#in-possession-1)).
+
+Once signed in, here is what you will have access to:
+
+## Start comparing Physical players outputs
+
+A good way to start is by requesting data for players from your own team.
+
+As an example, we will therefore access Physical data from the French team Stade Lavallois, that played in Ligue 2 for the 2022/23 season.
+
+**Permission management  
+**Depending on your current subscription, you will only be able to obtain data for specific competitions, matches and packages.
+
+If you have questions regarding permissions, you can [send us an email](mailto:support@skillcorner.com).
+
+Let see what our selection would look like for players from Stade Lavallois, with a breakdown by season average:
+
+## Add more advanced filters
+
+Now that we have requested data for our club, we can have a look at the teams within our championship.
+
+While using the web app, you will have to deal with three primary elements (selection, filters, reports) which are summarized in turn:
+
+**Selection Criteria**
+
+In this first section, each selection box is dynamic. If you select a given competition or team, the match and player selection will only show relevant matches and players relevant to the selected league or team.
+
+**Match & age filters**
+
+By default, the filters in this section include all types of results/venues and the date, age range and minutes played filters are inactive. Consequently, the filters will only be applied if you wish to modify them.
+
+**Report section**
+
+In this last section, the options relate to how you want the data to be displayed. This will have an impact on the output once you generate a report. Here are the key elements:
+
+-   Periods: 1st/2nd half breakdown  
+    
+-   Possession: Breakdown of Time in Possession (TIP) and Opponent Time in Possession (OTIP)  
+    You can learn more about this topic [here.](https://skillcorner.crunch.help/en/working-with-the-data/physical-data-glossary-1)
+-   Output: 
+    -   Player level (to see the metrics by player) or Position Group Benchmark (to see the metrics by position group – central defender, full back, midfield, winger and forward)
+    -   Match-by-Match or Average
+
+**Thresholds  
+**We usually recommend that your request is focused on players that played more than 10 games of 60 minutes to get a sample size that is relevant enough.
+
+Let see what our selection would look like for Forwards in Ligue 2, for the 2021/22 and 2022/23 seasons and a breakdown by club:  
+
+## Explore results and adjust display
+
+Once you have generated a report, you can start customizing the report output:
+
+-   The "General" tab allows you to adjust the first part of the table:  
+    \- The player ID column is the internal SkillCorner identification.  
+    \- Regarding performances, here is more context regarding our **Physical Quality Check** (PQC): it indicates if the quality of the data regarding a performance is high enough to be delivered. In some cases (issues with camera angles, jersey numbers readability, etc...) the quality check is _failed_ and no data is provided.
+-   The "Metrics" tab is useful to shape the table according to your preferences. The hidden columns will not appear when you make an export.
+-   The "P90" toggle allows you to normalise the data, by converting physical data outputs to per 90 minute equivalent values. 
+-   If you previously selected period (1st/2nd half) or possession (TIP/OTIP) breakdown, numerous additional columns will be introduced and the processing time will increase slightly.
+-   Once you are done shaping the table, you can download it to your computer by hitting "Export CSV".
+
+This is what the result will look like on your end:
+
+## Settings
+
+Finally, the settings icon at the top of the page allows you to switch speed measurement units.
+
+You will also get a chance to adjust the column separators in the csv downloaded file, which allows the data to be automatically formatted within MS Excel (the selection can differ in different countries).  
+Decimal separators can also be selected based on different country preferences. 
+
+Then, you can select whether you want to see the player performance information for matches where the SkillCorner physical data check has failed.
+
+If this option is selected, the players’ performances that do not pass physical quality thresholds will also appear in the search results, although no physical data will be displayed, just the minutes played during matches: 
+
+## In-possession data
+
+In order to get started with our second package, go to this [article](https://skillcorner.crunch.help/en/getting-started/explore-game-intelligence-data).

package/docs/_reference/skillcorner-crunch-help/getting-started-off-ball-run-sportscode-xml.md

@@ -0,0 +1,32 @@
+---
+source_url: https://skillcorner.crunch.help/en/getting-started/off-ball-run-sportscode-xml
+source_type: crunch_help_kb
+upstream_version:
+crawled_at: 2026-07-13T14:07:00.053Z
+---
+SkillCorner Provide an XML file compatible with Sportscode, SBG Focus and SBG MatchTracker.
+
+## Prerequisites
+
+You need to have
+
+-   A video of the match you want to visualise the run for
+-   The Sportscode XML of the Off-ball Runs. You can retrieve it from our WebApp (see after) or download it from our API (more details [here](https://skillcorner.crunch.help/en/getting-started/api-access-dynamic-events)).
+-   Access to Video Analysis tool like Sportscode, SBG Focus or SBG MatchTracker that accepts Sportscode XML
+
+## \[Non Technical Users\] Access Dynamic Events XML via SkillCorner Webapp
+
+## Using the XML in Sportscode
+
+The XML file contains
+
+-   The Off-ball Runs captured during the match with the following characteristics: 
+    -   The identity of the runner
+    -   The run type
+    -   Where the run starts
+    -   Whether it leads to a shot or a goal
+    -   Whether the player receives the ball
+    -   The identity of the player in possession
+-   The period start of each period to help sync the events with the video
+
+This short video explicit how you can use this XML file with Sportscode.

package/docs/_reference/skillcorner-crunch-help/getting-started-on-ball-engagement-video-definitio.md

@@ -0,0 +1,15 @@
+---
+source_url: https://skillcorner.crunch.help/en/getting-started/on-ball-engagement-video-definitions
+source_type: crunch_help_kb
+upstream_version:
+crawled_at: 2026-07-13T14:06:57.687Z
+---
+SkillCorner Pressing, Pressure, Force Backwards, ... definitions on video
+
+YE
+
+Written by Yacine Elliq
+
+Updated 1 month ago
+
+Did this answer your question?

package/docs/_reference/skillcorner-crunch-help/getting-started-python-retrieve-dynamic-events-fil.md

@@ -0,0 +1,102 @@
+---
+source_url: https://skillcorner.crunch.help/en/getting-started/python-retrieve-dynamic-events-files
+source_type: crunch_help_kb
+upstream_version:
+crawled_at: 2026-07-13T14:06:42.572Z
+---
+## Prerequisites
+
+-   Python 3.8 or above installed.
+-   SkillCorner Python Client. If you don't have it, refer to [this article](https://skillcorner.crunch.help/en/getting-started/skillcorner-python-client).
+
+## Code Snippet
+
+The first step consists in listing the match IDs for which we want to retrieve the Dynamic Events.
+
+Here we assume we want to retrieve the Dynamic Events for a given competition editions (ID 555 = ITA - Serie A - 2023/2024):
+
+```
+# Import SkillcornerClient from the skillcorner package
+from skillcorner.client import SkillcornerClient
+
+# Initialize the SkillcornerClient
+client = SkillcornerClient(username='USERNAME',password='PASSWORD')
+
+# Define the competition edition ID
+ce_id = 555  # Example competition edition ID
+
+# Retrieve the list of matches in the competition edition
+matches = client.get_matches(params={'competition_edition': ce_id})
+```
+
+We don't deliver dynamic events for every match.
+
+We just deliver it when dynamic\_events\_check value is true.
+
+You can retrieve the dynamic\_events\_check value for a give match via the data collection endpoint.
+
+```
+# Retrieve the data collections for each match
+data_collections = [client.get_match_data_collection(m['id']) for m in matches]
+```
+
+Now we can retrieve the Dynamic Events files for the matches of interest.
+
+-   We first define in which folder we want to store the files. If the folder does not exist, we create it. 
+-   Then, we loop through the match ID for which dynamic\_events\_check is true and retrieve the files (on the below snippet we just go through the first 10 matches):
+
+```
+import os
+
+# Define the folder where files will be saved
+folder = "NameOfYourFolder"
+if not os.path.exists(folder):
+    os.makedirs(folder)
+
+# Define the file format and extension
+file_format = 'csv'  # Accepted values: ['csv', 'sportscode-xml']
+extension = 'csv'    # Accepted values: ['csv', 'xml']
+
+# Loop through the data collections and save the dynamic events CSV files
+for counter, dc in enumerate(data_collections[:10], start=1): # Remove the [:10] when you are ready to do it for a complete competition edition
+    match_id = dc['match_id']
+    print(f"Processing match_id {match_id}: {counter}/{len(data_collections)}")
+    
+    if dc["dynamic_events_check"]: # We retrieve the file only when dynamic_events_check value is true
+        filepath = f"{folder}/{match_id}_dynamic_events.{extension}"
+        try:
+            client.save_dynamic_events(match_id=dc["match_id"], filepath=filepath, params={'file_format': file_format})
+        except Exception as err:
+            print(f"Error occurred for match_id {match_id}: {err}")
+```
+
+**Need some Help?**  
+Send us an email at _support@skillcorner.com_.
+
+## Regular Sync
+
+**Don't query all the files again and again!**
+
+Once you have stored once the Dynamic Events files,  
+Next time you want to retrieve the new/updated Dynamic Events files you **SHOULD NOT** query all the files.
+
+You **SHOULD** just retrieve the new files or the ones that have been updated since your last synchronisation.
+
+To do so, you just have to do one slight modification to the code snippets shared above to use the dynamic\_events\_last\_modified\_\_gte parameter from the [get\_matches()](https://skillcorner.readthedocs.io/en/latest/skillcorner_client.html#skillcorner.client.SkillcornerClient.get_matches) method.
+
+Let's say last time your queried the data was July 14, 2024.  
+You can use the code snippet shared above but you need to replace this line:
+
+```
+matches = client.get_matches(params={'competition_edition': ce_id})
+```
+
+by this line:
+
+```
+matches = client.get_matches(params={'competition_edition': ce_id, 'dynamic_events_last_modified__gte':'2024-07-14'})
+```
+
+**Explanation**
+
+-   By using the dynamic\_events\_last\_modified\_\_gte set to '2024-07-14' you will only retrieve the data for the matches that have been updated since the July 14, 2024.

package/docs/_reference/skillcorner-crunch-help/getting-started-python-retrieve-game-intelligence-.md

@@ -0,0 +1,158 @@
+---
+source_url: https://skillcorner.crunch.help/en/getting-started/python-retrieve-game-intelligence-data
+source_type: crunch_help_kb
+upstream_version:
+crawled_at: 2026-07-13T14:06:40.084Z
+---
+## Prerequisites
+
+-   You have installed the [SkillCorner Python Client](https://skillcorner.crunch.help/en/getting-started/skillcorner-python-client).
+-   You have read our article on how to [Use SkillCorner API](https://skillcorner.crunch.help/en/getting-started/using-skillcorner-api).
+
+## Instantiate the Python Client
+
+```
+from skillcorner.client import SkillcornerClient
+
+username = "YOUR USERNAME"
+password = "YOUR PASSWORD"
+client = SkillcornerClient(username=username, password=password)
+```
+
+## Access Off-Ball Run aggregates
+
+Let's say you have access to match ID 129588 (if not, just use another match ID) and you have check that the data collection status is "postmatch".
+
+The most basic request to get access to the this match off-ball runs aggregate consist in:
+
+```
+match_id = 129588
+
+## Basic Request
+off_ball_runs_agg = client.get_in_possession_off_ball_runs(params={
+    'match': match_id
+}) 
+```
+
+You can filter these aggregates by third and channel:
+
+```
+## Filter by third and/or channel. You can only select on thrid at a time and one channel at a time.
+# Third values available: 'all', 'defending', 'middle', 'attacking' 
+# channel values available: 'all', 'wide_left', 'wide_right', 'left_half_space', 'right_half_space', 'central'
+
+match_id = 129588
+
+third = 'attacking'
+channel = 'central'
+
+on_ball_pressure_agg = client.get_in_possession_off_ball_runs(params={
+    'match': match_id,
+    'third': third,
+    'channel': channel
+}) 
+```
+
+You can also break these aggregates by run types:
+
+```
+## Breakdown per run types
+# Run type values available: 'all', 'run_in_behind', 'run_ahead_of_the_ball', 'support_run', 'pulling_wide_run', 'coming_short_run', 'underlap_run', 'overlap_run', 'dropping_off_run', 'pulling_half_space_run', 'cross_receiver_run'. 
+# You can combine them but we don't support python list, your list should be a string
+
+match_id = 129588
+third = 'attacking'
+channel = 'central'
+
+run_type = 'run_in_behind,run_ahead_of_the_ball'
+
+on_ball_pressure_agg = client.get_in_possession_off_ball_runs(params={
+    'match': match_id,
+    'third': third,
+    'channel': channel,
+    'run_type':run_type
+})
+```
+
+Let's imagine that, it is not a particular match but the average number of off-ball runs performed by a player per match on a whole competition edition (e.g. FRA - Ligue 1 2021/2022 which ID is 242) that interests you.
+
+```
+competition_edition_id = 242
+
+## Basic Request
+off_ball_runs_agg = client.get_in_possession_off_ball_runs(params={
+    'competition_edition': competition_edition_id,
+    'average_per': 'match',
+    'group_by': 'player'
+}) 
+```
+
+## Access Passe aggregates
+
+Same logic as for Off-ball runs but instead of client.get\_in\_possession\_off\_ball\_runs(), use client.get\_in\_possession\_passes().
+
+## Access Pressure aggregates
+
+The most basic request consist in:
+
+```
+match_id = 129588
+
+## Basic Request
+on_ball_pressure_agg = client.get_in_possession_on_ball_pressures(params={
+    'match': match_id
+}) 
+```
+
+You can filter these aggregates by third and channels:
+
+```
+## Filter by third and/or channel. You can only select on thrid at a time and one channel at a time.
+# third values available: 'all', 'defending', 'middle', 'attacking' 
+# channel values available: 'all', 'wide_left', 'wide_right', 'left_half_space', 'right_half_space', 'central'
+
+match_id = 129588
+
+third = 'attacking'
+channel = 'central'
+
+on_ball_pressure_agg = client.get_in_possession_on_ball_pressures(params={
+    'match': match_id,
+    'third': third,
+    'channel': channel
+}) 
+```
+
+You can also break these aggregates by pressure intensity:
+
+```
+## Breakdown per pressure intensity
+# Pressure intensites values available: 'all', 'high', 'medium', 'low'. 
+# You can combine them but we don't support python list, your list should be a string
+
+match_id = 129588
+third = 'attacking'
+channel = 'central'
+
+pressure_intensity = 'all,high,medium,low'
+
+on_ball_pressure_agg = client.get_in_possession_on_ball_pressures(params={
+    'match': match_id,
+    'third': third,
+    'channel': channel,
+    'pressure_intensity':pressure_intensity
+})
+```
+
+Let's imagine that, it is not a particular match but the average number of pressures received by a player per match on a whole competition edition (e.g. FRA - Ligue 1 2021/2022 which ID is 242) that interests you.
+
+```
+competition_edition_id = 242
+
+## Basic Request
+on_ball_pressure_agg = client.get_in_possession_on_ball_pressures(params={
+    'competition_edition': competition_edition_id,
+    'average_per': 'match',
+    'group_by': 'player'
+}) 
+```