mlbstats/api/docs/SkeletalApi.md

88 lines
3.4 KiB
Markdown
Raw Normal View History

2025-04-06 04:55:01 +00:00
# {{classname}}
All URIs are relative to *https://statsapi.mlb.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**SkeletalChunked**](SkeletalApi.md#SkeletalChunked) | **Get** /api/v1/game/{gamePk}/{playId}/analytics/skeletalData/chunked | View Skeletal Data by playId and gameId chunked
[**SkeletalDataFileNames**](SkeletalApi.md#SkeletalDataFileNames) | **Get** /api/v1/game/{gamePk}/{playId}/analytics/skeletalData/files | View Skeletal Data by playId and gameId files
# **SkeletalChunked**
> string SkeletalChunked(ctx, gamePk, playId, fileName, optional)
View Skeletal Data by playId and gameId chunked
This endpoint allows you to pull chunked skeletal tracking data by gameId and playId
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**gamePk** | **int32**| Unique Primary Key Representing a Game |
**playId** | **string**| Unique play identifier |
**fileName** | **string**| Skeletal chunked file name |
**optional** | ***SkeletalApiSkeletalChunkedOpts** | optional parameters | nil if no parameters
### Optional Parameters
Optional parameters are passed through a pointer to a SkeletalApiSkeletalChunkedOpts struct
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**fields** | [**optional.Interface of []string**](string.md)| Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute |
### Return type
**string**
### Authorization
[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **SkeletalDataFileNames**
> SkeletalFileData SkeletalDataFileNames(ctx, gamePk, playId, optional)
View Skeletal Data by playId and gameId files
This endpoint allows you to pull chunked skeletal tracking data by gameId and playId
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**gamePk** | **int32**| Unique Primary Key Representing a Game |
**playId** | **string**| Unique play identifier |
**optional** | ***SkeletalApiSkeletalDataFileNamesOpts** | optional parameters | nil if no parameters
### Optional Parameters
Optional parameters are passed through a pointer to a SkeletalApiSkeletalDataFileNamesOpts struct
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**fields** | [**optional.Interface of []string**](string.md)| Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute |
### Return type
[**SkeletalFileData**](SkeletalFileData.md)
### Authorization
[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)