Skip to content

Latest commit

 

History

History
182 lines (144 loc) · 9 KB

PublicPerformanceApi.md

File metadata and controls

182 lines (144 loc) · 9 KB
Raw

HubSpot.NET.Api.PublicPerformanceApi

All URIs are relative to https://api.hubapi.com

Method HTTP request Description
GetCmsV3PerformanceGetPage GET /cms/v3/performance/ View your website's performance.
GetCmsV3PerformanceUptimeGetUptime GET /cms/v3/performance/uptime View your website's uptime.

GetCmsV3PerformanceGetPage

PublicPerformanceResponse GetCmsV3PerformanceGetPage (string domain = null, string path = null, bool? pad = null, bool? sum = null, string period = null, string interval = null, long? start = null, long? end = null)

View your website's performance.

Returns time series data website performance data for the given domain and/or path.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetCmsV3PerformanceGetPageExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new PublicPerformanceApi(config);
            var domain = "domain_example";  // string | The domain to search return data for. (optional) 
            var path = "path_example";  // string | The url path of the domain to return data for. (optional) 
            var pad = true;  // bool? | Specifies whether the time series data should have empty intervals if performance data is not present to create a continuous set. (optional) 
            var sum = true;  // bool? | Specifies whether the time series data should be summated for the given period. Defaults to false. (optional) 
            var period = "period_example";  // string | A relative period to return time series data for. This value is ignored if start and/or end are provided. Valid periods: [15m, 30m, 1h, 4h, 12h, 1d, 1w] (optional) 
            var interval = "interval_example";  // string | The time series interval to group data by. Valid intervals: [1m, 5m, 15m, 30m, 1h, 4h, 12h, 1d, 1w] (optional) 
            var start = 789L;  // long? | A timestamp in milliseconds that indicates the start of the time period. (optional) 
            var end = 789L;  // long? | A timestamp in milliseconds that indicates the end of the time period. (optional) 

            try
            {
                // View your website's performance.
                PublicPerformanceResponse result = apiInstance.GetCmsV3PerformanceGetPage(domain, path, pad, sum, period, interval, start, end);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling PublicPerformanceApi.GetCmsV3PerformanceGetPage: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
domain string The domain to search return data for. [optional]
path string The url path of the domain to return data for. [optional]
pad bool? Specifies whether the time series data should have empty intervals if performance data is not present to create a continuous set. [optional]
sum bool? Specifies whether the time series data should be summated for the given period. Defaults to false. [optional]
period string A relative period to return time series data for. This value is ignored if start and/or end are provided. Valid periods: [15m, 30m, 1h, 4h, 12h, 1d, 1w] [optional]
interval string The time series interval to group data by. Valid intervals: [1m, 5m, 15m, 30m, 1h, 4h, 12h, 1d, 1w] [optional]
start long? A timestamp in milliseconds that indicates the start of the time period. [optional]
end long? A timestamp in milliseconds that indicates the end of the time period. [optional]

Return type

PublicPerformanceResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
0 An error occurred. -

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

GetCmsV3PerformanceUptimeGetUptime

PublicPerformanceResponse GetCmsV3PerformanceUptimeGetUptime (string domain = null, string path = null, bool? pad = null, bool? sum = null, string period = null, string interval = null, long? start = null, long? end = null)

View your website's uptime.

Returns uptime time series website performance data for the given domain.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetCmsV3PerformanceUptimeGetUptimeExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new PublicPerformanceApi(config);
            var domain = "domain_example";  // string | The domain to search return data for. (optional) 
            var path = "path_example";  // string |  (optional) 
            var pad = true;  // bool? | Specifies whether the time series data should have empty intervals if performance data is not present to create a continuous set. (optional) 
            var sum = true;  // bool? | Specifies whether the time series data should be summated for the given period. Defaults to false. (optional) 
            var period = "period_example";  // string | A relative period to return time series data for. This value is ignored if start and/or end are provided. Valid periods: [15m, 30m, 1h, 4h, 12h, 1d, 1w] (optional) 
            var interval = "interval_example";  // string | The time series interval to group data by. Valid intervals: [1m, 5m, 15m, 30m, 1h, 4h, 12h, 1d, 1w] (optional) 
            var start = 789L;  // long? | A timestamp in milliseconds that indicates the start of the time period. (optional) 
            var end = 789L;  // long? | A timestamp in milliseconds that indicates the end of the time period. (optional) 

            try
            {
                // View your website's uptime.
                PublicPerformanceResponse result = apiInstance.GetCmsV3PerformanceUptimeGetUptime(domain, path, pad, sum, period, interval, start, end);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling PublicPerformanceApi.GetCmsV3PerformanceUptimeGetUptime: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
domain string The domain to search return data for. [optional]
path string [optional]
pad bool? Specifies whether the time series data should have empty intervals if performance data is not present to create a continuous set. [optional]
sum bool? Specifies whether the time series data should be summated for the given period. Defaults to false. [optional]
period string A relative period to return time series data for. This value is ignored if start and/or end are provided. Valid periods: [15m, 30m, 1h, 4h, 12h, 1d, 1w] [optional]
interval string The time series interval to group data by. Valid intervals: [1m, 5m, 15m, 30m, 1h, 4h, 12h, 1d, 1w] [optional]
start long? A timestamp in milliseconds that indicates the start of the time period. [optional]
end long? A timestamp in milliseconds that indicates the end of the time period. [optional]

Return type

PublicPerformanceResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
0 An error occurred. -

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