Class PublicPerformanceApi

Constructors

new PublicPerformanceApi(configuration, requestFactory?, responseProcessor?): PublicPerformanceApi
Parameters
- configuration: Configuration
- OptionalrequestFactory: PublicPerformanceApiRequestFactory
- OptionalresponseProcessor: PublicPerformanceApiResponseProcessor
Returns PublicPerformanceApi
- Defined in codegen/cms/performance/types/PromiseAPI.ts:11

getPage(domain?, path?, pad?, sum?, period?, interval?, start?, end?, _options?): Promise<PublicPerformanceResponse>
Returns time series data website performance data for the given domain and/or path. View your website's performance.
Parameters
- Optionaldomain: string
  The domain to search return data for.
- Optionalpath: string
  The url path of the domain to return data for.
- Optionalpad: boolean
  Specifies whether the time series data should have empty intervals if performance data is not present to create a continuous set.
- Optionalsum: boolean
  Specifies whether the time series data should be summated for the given period. Defaults to false.
- Optionalperiod: 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]
- Optionalinterval: string
  The time series interval to group data by. Valid intervals: [1m, 5m, 15m, 30m, 1h, 4h, 12h, 1d, 1w]
- Optionalstart: number
  A timestamp in milliseconds that indicates the start of the time period.
- Optionalend: number
  A timestamp in milliseconds that indicates the end of the time period.
- Optional_options: Configuration
Returns Promise<PublicPerformanceResponse>
- Defined in codegen/cms/performance/types/PromiseAPI.ts:48

getPageWithHttpInfo(domain?, path?, pad?, sum?, period?, interval?, start?, end?, _options?): Promise<HttpInfo<PublicPerformanceResponse>>
Returns time series data website performance data for the given domain and/or path. View your website's performance.
Parameters
- Optionaldomain: string
  The domain to search return data for.
- Optionalpath: string
  The url path of the domain to return data for.
- Optionalpad: boolean
  Specifies whether the time series data should have empty intervals if performance data is not present to create a continuous set.
- Optionalsum: boolean
  Specifies whether the time series data should be summated for the given period. Defaults to false.
- Optionalperiod: 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]
- Optionalinterval: string
  The time series interval to group data by. Valid intervals: [1m, 5m, 15m, 30m, 1h, 4h, 12h, 1d, 1w]
- Optionalstart: number
  A timestamp in milliseconds that indicates the start of the time period.
- Optionalend: number
  A timestamp in milliseconds that indicates the end of the time period.
- Optional_options: Configuration
Returns Promise<HttpInfo<PublicPerformanceResponse>>
- Defined in codegen/cms/performance/types/PromiseAPI.ts:31

getUptime(domain?, path?, pad?, sum?, period?, interval?, start?, end?, _options?): Promise<PublicPerformanceResponse>
Returns uptime time series website performance data for the given domain. View your website's uptime.
Parameters
- Optionaldomain: string
  The domain to search return data for.
- Optionalpath: string
- Optionalpad: boolean
  Specifies whether the time series data should have empty intervals if performance data is not present to create a continuous set.
- Optionalsum: boolean
  Specifies whether the time series data should be summated for the given period. Defaults to false.
- Optionalperiod: 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]
- Optionalinterval: string
  The time series interval to group data by. Valid intervals: [1m, 5m, 15m, 30m, 1h, 4h, 12h, 1d, 1w]
- Optionalstart: number
  A timestamp in milliseconds that indicates the start of the time period.
- Optionalend: number
  A timestamp in milliseconds that indicates the end of the time period.
- Optional_options: Configuration
Returns Promise<PublicPerformanceResponse>
- Defined in codegen/cms/performance/types/PromiseAPI.ts:82

getUptimeWithHttpInfo(domain?, path?, pad?, sum?, period?, interval?, start?, end?, _options?): Promise<HttpInfo<PublicPerformanceResponse>>
Returns uptime time series website performance data for the given domain. View your website's uptime.
Parameters
- Optionaldomain: string
  The domain to search return data for.
- Optionalpath: string
- Optionalpad: boolean
  Specifies whether the time series data should have empty intervals if performance data is not present to create a continuous set.
- Optionalsum: boolean
  Specifies whether the time series data should be summated for the given period. Defaults to false.
- Optionalperiod: 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]
- Optionalinterval: string
  The time series interval to group data by. Valid intervals: [1m, 5m, 15m, 30m, 1h, 4h, 12h, 1d, 1w]
- Optionalstart: number
  A timestamp in milliseconds that indicates the start of the time period.
- Optionalend: number
  A timestamp in milliseconds that indicates the end of the time period.
- Optional_options: Configuration
Returns Promise<HttpInfo<PublicPerformanceResponse>>
- Defined in codegen/cms/performance/types/PromiseAPI.ts:65