Skip to content

ApmApi.md

Latest commit

 

History

History
402 lines (302 loc) · 11.6 KB

ApmApi.md

File metadata and controls

402 lines (302 loc) · 11.6 KB

Flipdish.Api.ApmApi

All URIs are relative to https://api.flipdish.co

Method HTTP request Description
GetApmStatus GET /api/v1.0/{appId}/apm/status
GetBasicStatistics GET /api/v1.0/{appId}/apm/statistics
GetCalendarWeekStatistics GET /api/v1.0/{appId}/apm/statistics/calendar
GetCallsStatistics GET /api/v1.0/{appId}/apm/statistics/calls/{aggregateDataBy}
GetOrderStatistics GET /api/v1.0/{appId}/apm/statistics/orders/{aggregateDataBy}
GetPaginatedCallList GET /api/v1.0/{appId}/apm/calls

GetApmStatus

RestApiResultApmStatus GetApmStatus (string appId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetApmStatusExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ApmApi();
            var appId = appId_example;  // string | 

            try
            {
                RestApiResultApmStatus result = apiInstance.GetApmStatus(appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApmApi.GetApmStatus: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string

Return type

RestApiResultApmStatus

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetBasicStatistics

RestApiResultApmStatistics GetBasicStatistics (string appId, List<int?> storeId = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetBasicStatisticsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ApmApi();
            var appId = appId_example;  // string | 
            var storeId = new List<int?>(); // List<int?> |  (optional) 

            try
            {
                RestApiResultApmStatistics result = apiInstance.GetBasicStatistics(appId, storeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApmApi.GetBasicStatistics: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
storeId List<int?> [optional]

Return type

RestApiResultApmStatistics

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCalendarWeekStatistics

RestApiArrayResultApmHourlyDataPoint GetCalendarWeekStatistics (string appId, List<int?> storeId = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetCalendarWeekStatisticsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ApmApi();
            var appId = appId_example;  // string | 
            var storeId = new List<int?>(); // List<int?> |  (optional) 

            try
            {
                RestApiArrayResultApmHourlyDataPoint result = apiInstance.GetCalendarWeekStatistics(appId, storeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApmApi.GetCalendarWeekStatistics: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
storeId List<int?> [optional]

Return type

RestApiArrayResultApmHourlyDataPoint

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCallsStatistics

RestApiArrayResultApmDataPoint GetCallsStatistics (string appId, string aggregateDataBy, int? dataPointLimit = null, List<int?> storeId = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetCallsStatisticsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ApmApi();
            var appId = appId_example;  // string | 
            var aggregateDataBy = aggregateDataBy_example;  // string | 
            var dataPointLimit = 56;  // int? |  (optional) 
            var storeId = new List<int?>(); // List<int?> |  (optional) 

            try
            {
                RestApiArrayResultApmDataPoint result = apiInstance.GetCallsStatistics(appId, aggregateDataBy, dataPointLimit, storeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApmApi.GetCallsStatistics: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
aggregateDataBy string
dataPointLimit int? [optional]
storeId List<int?> [optional]

Return type

RestApiArrayResultApmDataPoint

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetOrderStatistics

RestApiArrayResultApmCurrencyDataPoint GetOrderStatistics (string appId, string aggregateDataBy, int? dataPointLimit = null, List<int?> storeId = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetOrderStatisticsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ApmApi();
            var appId = appId_example;  // string | 
            var aggregateDataBy = aggregateDataBy_example;  // string | 
            var dataPointLimit = 56;  // int? |  (optional) 
            var storeId = new List<int?>(); // List<int?> |  (optional) 

            try
            {
                RestApiArrayResultApmCurrencyDataPoint result = apiInstance.GetOrderStatistics(appId, aggregateDataBy, dataPointLimit, storeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApmApi.GetOrderStatistics: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
aggregateDataBy string
dataPointLimit int? [optional]
storeId List<int?> [optional]

Return type

RestApiArrayResultApmCurrencyDataPoint

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPaginatedCallList

RestApiPaginationResultPhoneCall GetPaginatedCallList (string appId, int? page = null, int? limit = null, List<int?> storeId = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetPaginatedCallListExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ApmApi();
            var appId = appId_example;  // string | 
            var page = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 
            var storeId = new List<int?>(); // List<int?> |  (optional) 

            try
            {
                RestApiPaginationResultPhoneCall result = apiInstance.GetPaginatedCallList(appId, page, limit, storeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApmApi.GetPaginatedCallList: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
page int? [optional]
limit int? [optional]
storeId List<int?> [optional]

Return type

RestApiPaginationResultPhoneCall

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]