UNPKG

@tennac-booking/sdk

Version:

OpenAPI client for @tennac-booking/sdk

1,290 lines (848 loc) 33.9 kB
# ClubAnalyticsStaffApi All URIs are relative to *http://localhost* |Method | HTTP request | Description| |------------- | ------------- | -------------| |[**getAnalyticsBySport**](#getanalyticsbysport) | **GET** /api/club-analytics/sport/{sportId}/analytics | | |[**getBookingsPerDay**](#getbookingsperday) | **GET** /api/club-analytics/bookings/per-day | | |[**getClubPlayerBookingsById**](#getclubplayerbookingsbyid) | **GET** /api/club-analytics/players/{playerId}/bookings | | |[**getClubPlayerById**](#getclubplayerbyid) | **GET** /api/club-analytics/players/{playerId} | | |[**getClubPlayerStatisticsById**](#getclubplayerstatisticsbyid) | **GET** /api/club-analytics/players/{playerId}/statistics | | |[**getClubPlayers**](#getclubplayers) | **GET** /api/club-analytics/players | | |[**getClubSubscribersSummary**](#getclubsubscriberssummary) | **GET** /api/club-analytics/subscribers/total | | |[**getDailyTurnOver**](#getdailyturnover) | **GET** /api/club-analytics/daily-turnover | | |[**getGenderPercentage**](#getgenderpercentage) | **GET** /api/club-analytics/gender-percentage | | |[**getInfillPercentagePerPeriod**](#getinfillpercentageperperiod) | **GET** /api/club-analytics/infill-percentage | | |[**getLastSixMonthsTurnover**](#getlastsixmonthsturnover) | **GET** /api/club-analytics/last-six-months-turnover | | |[**getLeastBookedTimeSlots**](#getleastbookedtimeslots) | **GET** /api/club-analytics/bookings/least-booked-time-slots | | |[**getLeastBookedWeekday**](#getleastbookedweekday) | **GET** /api/club-analytics/bookings/least-booked-weekday | | |[**getMonthlyTurnOver**](#getmonthlyturnover) | **GET** /api/club-analytics/monthly-turnover | | |[**getNewBookingsCount**](#getnewbookingscount) | **GET** /api/club-analytics/bookings/new | | |[**getNewSubscribersCount**](#getnewsubscriberscount) | **GET** /api/club-analytics/subscribers/new | | |[**getNewSubscribersList**](#getnewsubscriberslist) | **GET** /api/club-analytics/subscribers/new/list | | |[**getNoShowRate**](#getnoshowrate) | **GET** /api/club-analytics/bookings/no-show-rate | | |[**getNumberOfClubUsers**](#getnumberofclubusers) | **GET** /api/club-analytics/users-count | | |[**getRetentionRate**](#getretentionrate) | **GET** /api/club-analytics/retention-rate | | |[**getRevenueBySport**](#getrevenuebysport) | **GET** /api/club-analytics/revenue-by-sport | | |[**getTenNextBookings**](#gettennextbookings) | **GET** /api/club-analytics/next-bookings | | |[**getTopCourtsByBookings**](#gettopcourtsbybookings) | **GET** /api/club-analytics/top-courts | | |[**getYearlyTurnOver**](#getyearlyturnover) | **GET** /api/club-analytics/yearly-turnover | | # **getAnalyticsBySport** > SportAnalyticsResponse getAnalyticsBySport() Récupère les analytics par sport ### Example ```typescript import { ClubAnalyticsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubAnalyticsStaffApi(configuration); let sportId: string; // (default to undefined) const { status, data } = await apiInstance.getAnalyticsBySport( sportId ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **sportId** | [**string**] | | defaults to undefined| ### Return type **SportAnalyticsResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Analytics du sport | - | |**400** | Bad Request | - | |**401** | Unauthorized | - | |**500** | Server Error | - | [[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) # **getBookingsPerDay** > BookingsPerDayResponse getBookingsPerDay() Nombre de réservations par jour en fonction des slots ### Example ```typescript import { ClubAnalyticsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubAnalyticsStaffApi(configuration); let startDate: string; // (optional) (default to undefined) let endDate: string; // (optional) (default to undefined) const { status, data } = await apiInstance.getBookingsPerDay( startDate, endDate ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **startDate** | [**string**] | | (optional) defaults to undefined| | **endDate** | [**string**] | | (optional) defaults to undefined| ### Return type **BookingsPerDayResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Réservations par jour | - | |**400** | Bad Request | - | |**401** | Unauthorized | - | [[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) # **getClubPlayerBookingsById** > ClubPlayerBookingsResponse getClubPlayerBookingsById() Récupère les réservations d\'un joueur par son ID (à venir et passées) ### Example ```typescript import { ClubAnalyticsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubAnalyticsStaffApi(configuration); let playerId: string; // (default to undefined) let page: number; // (optional) (default to undefined) let pageSize: number; // (optional) (default to undefined) const { status, data } = await apiInstance.getClubPlayerBookingsById( playerId, page, pageSize ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **playerId** | [**string**] | | defaults to undefined| | **page** | [**number**] | | (optional) defaults to undefined| | **pageSize** | [**number**] | | (optional) defaults to undefined| ### Return type **ClubPlayerBookingsResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Réservations du joueur | - | |**400** | Bad Request | - | |**401** | Unauthorized | - | |**500** | Server Error | - | [[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) # **getClubPlayerById** > ClubPlayerDetailResponse getClubPlayerById() Récupère les informations détaillées d\'un joueur par son ID ### Example ```typescript import { ClubAnalyticsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubAnalyticsStaffApi(configuration); let playerId: string; // (default to undefined) const { status, data } = await apiInstance.getClubPlayerById( playerId ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **playerId** | [**string**] | | defaults to undefined| ### Return type **ClubPlayerDetailResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Informations du joueur | - | |**400** | Bad Request | - | |**401** | Unauthorized | - | |**404** | Not Found | - | |**500** | Server Error | - | [[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) # **getClubPlayerStatisticsById** > ClubPlayerStatisticsResponse getClubPlayerStatisticsById() Récupère les statistiques d\'un joueur pour le staff ### Example ```typescript import { ClubAnalyticsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubAnalyticsStaffApi(configuration); let playerId: string; // (default to undefined) const { status, data } = await apiInstance.getClubPlayerStatisticsById( playerId ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **playerId** | [**string**] | | defaults to undefined| ### Return type **ClubPlayerStatisticsResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Statistiques du joueur | - | |**400** | Bad Request | - | |**401** | Unauthorized | - | |**404** | Not Found | - | |**500** | Server Error | - | [[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) # **getClubPlayers** > ClubPlayersPaginatedResponse getClubPlayers() Récupère la liste des joueurs du club ### Example ```typescript import { ClubAnalyticsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubAnalyticsStaffApi(configuration); let page: number; // (optional) (default to undefined) let pageSize: number; // (optional) (default to undefined) let search: string; // (optional) (default to undefined) let filters: string; // (optional) (default to undefined) let sorting: string; // (optional) (default to undefined) const { status, data } = await apiInstance.getClubPlayers( page, pageSize, search, filters, sorting ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **page** | [**number**] | | (optional) defaults to undefined| | **pageSize** | [**number**] | | (optional) defaults to undefined| | **search** | [**string**] | | (optional) defaults to undefined| | **filters** | [**string**] | | (optional) defaults to undefined| | **sorting** | [**string**] | | (optional) defaults to undefined| ### Return type **ClubPlayersPaginatedResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Liste des joueurs du club | - | |**401** | Unauthorized | - | |**500** | Server Error | - | [[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) # **getClubSubscribersSummary** > ClubSubscriberSummaryResponse getClubSubscribersSummary() Nombre total d\'abonnés actifs du club ### Example ```typescript import { ClubAnalyticsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubAnalyticsStaffApi(configuration); const { status, data } = await apiInstance.getClubSubscribersSummary(); ``` ### Parameters This endpoint does not have any parameters. ### Return type **ClubSubscriberSummaryResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Total des abonnés | - | |**400** | Bad Request | - | |**401** | Unauthorized | - | [[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) # **getDailyTurnOver** > DailyTurnoverResponse getDailyTurnOver() Récupère le chiffre d\'affaires quotidien ### Example ```typescript import { ClubAnalyticsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubAnalyticsStaffApi(configuration); let date: string; // (default to undefined) const { status, data } = await apiInstance.getDailyTurnOver( date ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **date** | [**string**] | | defaults to undefined| ### Return type **DailyTurnoverResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Chiffre d\&#39;affaires quotidien | - | |**400** | Bad Request | - | |**401** | Unauthorized | - | |**500** | Server Error | - | [[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) # **getGenderPercentage** > GenderPercentageResponse getGenderPercentage() Récupère les pourcentages par genre ### Example ```typescript import { ClubAnalyticsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubAnalyticsStaffApi(configuration); const { status, data } = await apiInstance.getGenderPercentage(); ``` ### Parameters This endpoint does not have any parameters. ### Return type **GenderPercentageResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Pourcentages par genre | - | |**401** | Unauthorized | - | |**500** | Server Error | - | [[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) # **getInfillPercentagePerPeriod** > GetInfillPercentagePerPeriod200Response getInfillPercentagePerPeriod() Récupère le taux de remplissage (infill) pour une période donnée ### Example ```typescript import { ClubAnalyticsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubAnalyticsStaffApi(configuration); let startDate: string; // (optional) (default to undefined) let endDate: string; // (optional) (default to undefined) const { status, data } = await apiInstance.getInfillPercentagePerPeriod( startDate, endDate ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **startDate** | [**string**] | | (optional) defaults to undefined| | **endDate** | [**string**] | | (optional) defaults to undefined| ### Return type **GetInfillPercentagePerPeriod200Response** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Taux de remplissage | - | |**400** | Bad Request | - | |**401** | Unauthorized | - | |**500** | Server Error | - | [[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) # **getLastSixMonthsTurnover** > Array<LastSixMonthsTurnoverItem> getLastSixMonthsTurnover() Récupère le chiffre d\'affaires des 6 derniers mois ### Example ```typescript import { ClubAnalyticsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubAnalyticsStaffApi(configuration); const { status, data } = await apiInstance.getLastSixMonthsTurnover(); ``` ### Parameters This endpoint does not have any parameters. ### Return type **Array<LastSixMonthsTurnoverItem>** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Chiffre d\&#39;affaires des 6 derniers mois | - | |**401** | Unauthorized | - | |**500** | Server Error | - | [[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) # **getLeastBookedTimeSlots** > LeastBookedTimeSlotsResponse getLeastBookedTimeSlots() Créneaux horaires les moins réservés (3 derniers mois) ### Example ```typescript import { ClubAnalyticsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubAnalyticsStaffApi(configuration); let limit: number; // (optional) (default to undefined) const { status, data } = await apiInstance.getLeastBookedTimeSlots( limit ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **limit** | [**number**] | | (optional) defaults to undefined| ### Return type **LeastBookedTimeSlotsResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Créneaux les moins réservés | - | |**400** | Bad Request | - | |**401** | Unauthorized | - | [[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) # **getLeastBookedWeekday** > LeastBookedWeekdayResponse getLeastBookedWeekday() Jour de la semaine le moins réservé (3 derniers mois) ### Example ```typescript import { ClubAnalyticsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubAnalyticsStaffApi(configuration); const { status, data } = await apiInstance.getLeastBookedWeekday(); ``` ### Parameters This endpoint does not have any parameters. ### Return type **LeastBookedWeekdayResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Jour le moins réservé | - | |**400** | Bad Request | - | |**401** | Unauthorized | - | [[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) # **getMonthlyTurnOver** > MonthlyTurnoverResponse getMonthlyTurnOver() Récupère le chiffre d\'affaires mensuel ### Example ```typescript import { ClubAnalyticsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubAnalyticsStaffApi(configuration); let year: string; // (default to undefined) let month: string; // (default to undefined) const { status, data } = await apiInstance.getMonthlyTurnOver( year, month ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **year** | [**string**] | | defaults to undefined| | **month** | [**string**] | | defaults to undefined| ### Return type **MonthlyTurnoverResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Chiffre d\&#39;affaires mensuel | - | |**400** | Bad Request | - | |**401** | Unauthorized | - | |**500** | Server Error | - | [[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) # **getNewBookingsCount** > ClubNewBookingsResponse getNewBookingsCount() Nouvelles réservations créées sur une période ### Example ```typescript import { ClubAnalyticsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubAnalyticsStaffApi(configuration); let startDate: string; // (optional) (default to undefined) let endDate: string; // (optional) (default to undefined) const { status, data } = await apiInstance.getNewBookingsCount( startDate, endDate ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **startDate** | [**string**] | | (optional) defaults to undefined| | **endDate** | [**string**] | | (optional) defaults to undefined| ### Return type **ClubNewBookingsResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Nouvelles réservations | - | |**400** | Bad Request | - | |**401** | Unauthorized | - | [[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) # **getNewSubscribersCount** > ClubNewSubscribersResponse getNewSubscribersCount() Nouveaux abonnés sur une période ### Example ```typescript import { ClubAnalyticsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubAnalyticsStaffApi(configuration); let startDate: string; // (optional) (default to undefined) let endDate: string; // (optional) (default to undefined) const { status, data } = await apiInstance.getNewSubscribersCount( startDate, endDate ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **startDate** | [**string**] | | (optional) defaults to undefined| | **endDate** | [**string**] | | (optional) defaults to undefined| ### Return type **ClubNewSubscribersResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Nouveaux abonnés sur la période | - | |**400** | Bad Request | - | |**401** | Unauthorized | - | [[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) # **getNewSubscribersList** > ClubNewSubscribersListResponse getNewSubscribersList() Liste des nouveaux abonnés (30 derniers jours) ### Example ```typescript import { ClubAnalyticsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubAnalyticsStaffApi(configuration); const { status, data } = await apiInstance.getNewSubscribersList(); ``` ### Parameters This endpoint does not have any parameters. ### Return type **ClubNewSubscribersListResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Nouveaux abonnés (30 derniers jours) | - | |**400** | Bad Request | - | |**401** | Unauthorized | - | [[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) # **getNoShowRate** > NoShowRateResponse getNoShowRate() Taux de no-show global ou sur une période ### Example ```typescript import { ClubAnalyticsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubAnalyticsStaffApi(configuration); let startDate: string; // (optional) (default to undefined) let endDate: string; // (optional) (default to undefined) const { status, data } = await apiInstance.getNoShowRate( startDate, endDate ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **startDate** | [**string**] | | (optional) defaults to undefined| | **endDate** | [**string**] | | (optional) defaults to undefined| ### Return type **NoShowRateResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Taux de no-show | - | |**400** | Bad Request | - | |**401** | Unauthorized | - | [[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) # **getNumberOfClubUsers** > ClubUserCountResponse getNumberOfClubUsers() Récupère le nombre d\'utilisateurs du club ### Example ```typescript import { ClubAnalyticsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubAnalyticsStaffApi(configuration); const { status, data } = await apiInstance.getNumberOfClubUsers(); ``` ### Parameters This endpoint does not have any parameters. ### Return type **ClubUserCountResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Nombre d\&#39;utilisateurs | - | |**401** | Unauthorized | - | |**500** | Server Error | - | [[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) # **getRetentionRate** > RetentionRateResponse getRetentionRate() Calcule le taux de fidélisation des joueurs ### Example ```typescript import { ClubAnalyticsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubAnalyticsStaffApi(configuration); let startDate: string; // (optional) (default to undefined) let endDate: string; // (optional) (default to undefined) const { status, data } = await apiInstance.getRetentionRate( startDate, endDate ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **startDate** | [**string**] | | (optional) defaults to undefined| | **endDate** | [**string**] | | (optional) defaults to undefined| ### Return type **RetentionRateResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Taux de fidélisation | - | |**401** | Unauthorized | - | |**500** | Server Error | - | [[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) # **getRevenueBySport** > Array<RevenueBySportItem> getRevenueBySport() Récupère le chiffre d\'affaires par sport ### Example ```typescript import { ClubAnalyticsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubAnalyticsStaffApi(configuration); const { status, data } = await apiInstance.getRevenueBySport(); ``` ### Parameters This endpoint does not have any parameters. ### Return type **Array<RevenueBySportItem>** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Répartition du CA par sport | - | |**401** | Unauthorized | - | |**500** | Server Error | - | [[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) # **getTenNextBookings** > Array<BookingAnalyticsResponse> getTenNextBookings() Récupère les 10 prochaines réservations ### Example ```typescript import { ClubAnalyticsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubAnalyticsStaffApi(configuration); const { status, data } = await apiInstance.getTenNextBookings(); ``` ### Parameters This endpoint does not have any parameters. ### Return type **Array<BookingAnalyticsResponse>** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Prochaines réservations | - | |**401** | Unauthorized | - | |**500** | Server Error | - | [[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) # **getTopCourtsByBookings** > Array<CourtBookingShareItem> getTopCourtsByBookings() Classement des terrains les plus réservés ### Example ```typescript import { ClubAnalyticsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubAnalyticsStaffApi(configuration); const { status, data } = await apiInstance.getTopCourtsByBookings(); ``` ### Parameters This endpoint does not have any parameters. ### Return type **Array<CourtBookingShareItem>** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Terrains les plus réservés | - | |**401** | Unauthorized | - | |**500** | Server Error | - | [[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) # **getYearlyTurnOver** > YearlyTurnoverResponse getYearlyTurnOver() Récupère le chiffre d\'affaires annuel avec détail mensuel ### Example ```typescript import { ClubAnalyticsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubAnalyticsStaffApi(configuration); let year: string; // (default to undefined) const { status, data } = await apiInstance.getYearlyTurnOver( year ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **year** | [**string**] | | defaults to undefined| ### Return type **YearlyTurnoverResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Chiffre d\&#39;affaires annuel | - | |**400** | Bad Request | - | |**401** | Unauthorized | - | |**500** | Server Error | - | [[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)