{
  "id": "@kbn/ebt-tools",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/ebt-tools",
        "id": "def-common.PerformanceContextProvider",
        "type": "Function",
        "tags": [],
        "label": "PerformanceContextProvider",
        "description": [],
        "signature": [
          "React.ForwardRefExoticComponent<{ children: React.ReactElement<any, string | React.JSXElementConstructor<any>>; } & React.RefAttributes<{}>>"
        ],
        "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metrics/index.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "returnComment": [],
        "children": [
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.PerformanceContextProvider.$1",
            "type": "Uncategorized",
            "tags": [],
            "label": "props",
            "description": [],
            "signature": [
              "P"
            ],
            "path": "node_modules/@types/react/ts5.0/index.d.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/ebt-tools",
        "id": "def-common.registerPerformanceMetricEventType",
        "type": "Function",
        "tags": [
          "private"
        ],
        "label": "registerPerformanceMetricEventType",
        "description": [
          "\nRegister the `performance_metric` event type"
        ],
        "signature": [
          "(analytics: Pick<",
          "IAnalyticsClient",
          ", \"registerEventType\">) => void"
        ],
        "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/helpers.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.registerPerformanceMetricEventType.$1",
            "type": "Object",
            "tags": [],
            "label": "analytics",
            "description": [
              "The {@link AnalyticsClient } during the setup phase (it has the method `registerEventType`)"
            ],
            "signature": [
              "Pick<",
              "IAnalyticsClient",
              ", \"registerEventType\">"
            ],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/helpers.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/ebt-tools",
        "id": "def-common.reportPerformanceMetricEvent",
        "type": "Function",
        "tags": [],
        "label": "reportPerformanceMetricEvent",
        "description": [
          "\nReport a `performance_metric` event type."
        ],
        "signature": [
          "(analytics: Pick<",
          "IAnalyticsClient",
          ", \"reportEvent\">, eventData: ",
          {
            "pluginId": "@kbn/ebt-tools",
            "scope": "common",
            "docId": "kibKbnEbtToolsPluginApi",
            "section": "def-common.PerformanceMetricEvent",
            "text": "PerformanceMetricEvent"
          },
          ") => void"
        ],
        "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/helpers.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.reportPerformanceMetricEvent.$1",
            "type": "Object",
            "tags": [],
            "label": "analytics",
            "description": [
              "The {@link AnalyticsClient } to report the events."
            ],
            "signature": [
              "Pick<",
              "IAnalyticsClient",
              ", \"reportEvent\">"
            ],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/helpers.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.reportPerformanceMetricEvent.$2",
            "type": "Object",
            "tags": [],
            "label": "eventData",
            "description": [
              "The data to send, conforming the structure of a {@link PerformanceMetricEvent }."
            ],
            "signature": [
              {
                "pluginId": "@kbn/ebt-tools",
                "scope": "common",
                "docId": "kibKbnEbtToolsPluginApi",
                "section": "def-common.PerformanceMetricEvent",
                "text": "PerformanceMetricEvent"
              }
            ],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/helpers.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/ebt-tools",
        "id": "def-common.usePageReady",
        "type": "Function",
        "tags": [],
        "label": "usePageReady",
        "description": [],
        "signature": [
          "(state: { customMetrics?: ",
          "CustomMetrics",
          " | undefined; isReady: boolean; meta?: ",
          "Meta",
          " | undefined; }) => void"
        ],
        "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metrics/context/use_page_ready.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.usePageReady.$1",
            "type": "Object",
            "tags": [],
            "label": "state",
            "description": [],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metrics/context/use_page_ready.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/ebt-tools",
                "id": "def-common.usePageReady.$1.customMetrics",
                "type": "Object",
                "tags": [],
                "label": "customMetrics",
                "description": [],
                "signature": [
                  "CustomMetrics",
                  " | undefined"
                ],
                "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metrics/context/use_page_ready.ts",
                "deprecated": false,
                "trackAdoption": false
              },
              {
                "parentPluginId": "@kbn/ebt-tools",
                "id": "def-common.usePageReady.$1.isReady",
                "type": "boolean",
                "tags": [],
                "label": "isReady",
                "description": [],
                "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metrics/context/use_page_ready.ts",
                "deprecated": false,
                "trackAdoption": false
              },
              {
                "parentPluginId": "@kbn/ebt-tools",
                "id": "def-common.usePageReady.$1.meta",
                "type": "Object",
                "tags": [],
                "label": "meta",
                "description": [],
                "signature": [
                  "Meta",
                  " | undefined"
                ],
                "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metrics/context/use_page_ready.ts",
                "deprecated": false,
                "trackAdoption": false
              }
            ]
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/ebt-tools",
        "id": "def-common.usePerformanceContext",
        "type": "Function",
        "tags": [],
        "label": "usePerformanceContext",
        "description": [],
        "signature": [
          "() => ",
          "PerformanceApi"
        ],
        "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metrics/context/use_performance_context.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "@kbn/ebt-tools",
        "id": "def-common.PerformanceMetricEvent",
        "type": "Interface",
        "tags": [],
        "label": "PerformanceMetricEvent",
        "description": [
          "\nStructure of the `metric` event"
        ],
        "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/schema.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.PerformanceMetricEvent.eventName",
            "type": "string",
            "tags": [],
            "label": "eventName",
            "description": [
              "\nThe name of the event that is tracked in the metrics i.e. kibana_loaded, kibana_started"
            ],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/schema.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.PerformanceMetricEvent.meta",
            "type": "Object",
            "tags": [],
            "label": "meta",
            "description": [
              "\nSearchable but not aggregateable metadata relevant to the tracked action."
            ],
            "signature": [
              "Record<string, unknown> | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/schema.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.PerformanceMetricEvent.duration",
            "type": "number",
            "tags": [
              "group"
            ],
            "label": "duration",
            "description": [],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/schema.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.PerformanceMetricEvent.key1",
            "type": "string",
            "tags": [
              "group"
            ],
            "label": "key1",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/schema.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.PerformanceMetricEvent.value1",
            "type": "number",
            "tags": [
              "group"
            ],
            "label": "value1",
            "description": [],
            "signature": [
              "number | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/schema.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.PerformanceMetricEvent.key2",
            "type": "string",
            "tags": [
              "group"
            ],
            "label": "key2",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/schema.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.PerformanceMetricEvent.value2",
            "type": "number",
            "tags": [
              "group"
            ],
            "label": "value2",
            "description": [],
            "signature": [
              "number | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/schema.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.PerformanceMetricEvent.key3",
            "type": "string",
            "tags": [
              "group"
            ],
            "label": "key3",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/schema.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.PerformanceMetricEvent.value3",
            "type": "number",
            "tags": [
              "group"
            ],
            "label": "value3",
            "description": [],
            "signature": [
              "number | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/schema.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.PerformanceMetricEvent.key4",
            "type": "string",
            "tags": [
              "group"
            ],
            "label": "key4",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/schema.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.PerformanceMetricEvent.value4",
            "type": "number",
            "tags": [
              "group"
            ],
            "label": "value4",
            "description": [],
            "signature": [
              "number | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/schema.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.PerformanceMetricEvent.key5",
            "type": "string",
            "tags": [
              "group"
            ],
            "label": "key5",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/schema.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.PerformanceMetricEvent.value5",
            "type": "number",
            "tags": [
              "group"
            ],
            "label": "value5",
            "description": [],
            "signature": [
              "number | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/schema.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.PerformanceMetricEvent.key6",
            "type": "string",
            "tags": [
              "group"
            ],
            "label": "key6",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/schema.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.PerformanceMetricEvent.value6",
            "type": "number",
            "tags": [
              "group"
            ],
            "label": "value6",
            "description": [],
            "signature": [
              "number | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/schema.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.PerformanceMetricEvent.key7",
            "type": "string",
            "tags": [
              "group"
            ],
            "label": "key7",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/schema.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.PerformanceMetricEvent.value7",
            "type": "number",
            "tags": [
              "group"
            ],
            "label": "value7",
            "description": [],
            "signature": [
              "number | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/schema.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.PerformanceMetricEvent.key8",
            "type": "string",
            "tags": [
              "group"
            ],
            "label": "key8",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/schema.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.PerformanceMetricEvent.value8",
            "type": "number",
            "tags": [
              "group"
            ],
            "label": "value8",
            "description": [],
            "signature": [
              "number | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/schema.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.PerformanceMetricEvent.key9",
            "type": "string",
            "tags": [
              "group"
            ],
            "label": "key9",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/schema.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.PerformanceMetricEvent.value9",
            "type": "number",
            "tags": [
              "group"
            ],
            "label": "value9",
            "description": [],
            "signature": [
              "number | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metric_events/schema.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [],
    "objects": [
      {
        "parentPluginId": "@kbn/ebt-tools",
        "id": "def-common.perfomanceMarkers",
        "type": "Object",
        "tags": [],
        "label": "perfomanceMarkers",
        "description": [],
        "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metrics/performance_markers.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.perfomanceMarkers.startPageChange",
            "type": "string",
            "tags": [],
            "label": "startPageChange",
            "description": [],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metrics/performance_markers.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.perfomanceMarkers.endPageReady",
            "type": "string",
            "tags": [],
            "label": "endPageReady",
            "description": [],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metrics/performance_markers.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ebt-tools",
            "id": "def-common.perfomanceMarkers.startPageRefresh",
            "type": "string",
            "tags": [],
            "label": "startPageRefresh",
            "description": [],
            "path": "src/platform/packages/shared/kbn-ebt-tools/src/performance_metrics/performance_markers.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ]
  }
}