Hierarchy

  • PublicPerformanceApi

Constructors

Properties

Methods

Constructors

Properties

api: ObservablePublicPerformanceApi

Methods

  • Returns time series data website performance data for the given domain and/or path. View your website's performance.

    Parameters

    • Optional domain: string

      The domain to search return data for.

    • Optional path: string

      The url path of the domain to return data for.

    • Optional pad: boolean

      Specifies whether the time series data should have empty intervals if performance data is not present to create a continuous set.

    • Optional sum: boolean

      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: number

      A timestamp in milliseconds that indicates the start of the time period.

    • Optional end: number

      A timestamp in milliseconds that indicates the end of the time period.

    • Optional _options: Configuration

    Returns Promise<PublicPerformanceResponse>

  • Returns uptime time series website performance data for the given domain. View your website's uptime.

    Parameters

    • Optional domain: string

      The domain to search return data for.

    • Optional path: string
    • Optional pad: boolean

      Specifies whether the time series data should have empty intervals if performance data is not present to create a continuous set.

    • Optional sum: boolean

      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: number

      A timestamp in milliseconds that indicates the start of the time period.

    • Optional end: number

      A timestamp in milliseconds that indicates the end of the time period.

    • Optional _options: Configuration

    Returns Promise<PublicPerformanceResponse>

Generated using TypeDoc