Eggplant Monitoring InsightsAPI主要是一個數據提取工具，允許用戶通過在格式標準HTTP請求，如XML，JSON，PHP或YAML直接訪問和提取物的測試結果。API 數據請求可用于從報告電子表格到實時報告應用程序的任何內容。API 是推薦的高級Eggplant監控洞察客戶導入實時和歷史數據的解決方案。

API基礎

您以HTTP請求的形式向Eggplant Monitoring Insights API進行查詢。使用 API 用戶界面設計和微調您的查詢。根據您的要求，您可以根據需要手動運行此查詢，也可以構建應用程序以編程方式調用該查詢。如果需要，您可以設計您的應用程序以進一步優化提取的數據，并以適合您的確切需求的格式呈現它。

要使用 API 用戶界面：

? 在//api.mon.eggplant.cloud訪問API用戶界面。

? 使用您的標準用戶名和密碼登錄。Eggplant Monitoring Insights生成一個 API 密鑰來驗證您的會話。

? 構建您的查詢。

? 運行您的查詢。

? 檢查以查看查詢是否返回所需的數據。

? （可選）修改并重新運行您的查詢，直到它返回您需要的數據。

API 密鑰

如上所述，在您登錄用戶界面后，API 使用密鑰來維護您的會話。密鑰對于每個會話都是唯一的，并且是發送到 API 的查詢 URL 的重要組成部分。

自上次使用后，該密鑰的有效期為 60 分鐘。這意味著如果密鑰每 59 分鐘至少使用一次，會話可以無限期地持續。如果密鑰過期，請注銷然后重新登錄以重新進行身份驗證并生成新密鑰。

注意：如果帳戶對 API 的訪問權限過期或被刪除，API 密鑰將自動過期。如果這種情況意外發生，請聯系您的客戶經理或支持人員。

您可以使用瀏覽器中的 URL 請求強制密鑰過期。例如，如果您被分配了密鑰abcdefghijklmnopqrstuvwxyz123456并需要強制它過期，則 URL 請求將是：

//api.mon.eggplant.cloud/current/abcdefghijklmnopqrstuvwxyz123456/Logout

使用查詢生成器

為了從 API 返回您需要的特定數據，查詢 URL 需要包含過濾結果數據的值。在查詢生成器 UI 中，您可以為所需數據選擇過濾器。然后，查詢構建器工具會為您構建正確的查詢 URL。

訪問查詢生成器

轉到位于//api.mon.eggplant.cloud的 API 用戶界面起始頁面，并使用您的Eggplant Monitoring Insights用戶名和密碼登錄。您的 API 密鑰在您登錄時生成。

注意： 您必須擁有與您的用戶帳戶關聯的 API 權限才能訪問 API。如果您不確定您的帳戶是否具有 API 權限，請聯系您的客戶經理。

登錄后，單擊Query Builder下的current以打開 Query Builder UI。

查詢生成器將在新選項卡或窗口中打開，具體取決于您的瀏覽器設置。

注意：如果您在API 直接調用下選擇當前，您將獲得一個 API 密鑰，并且無需查詢生成器的幫助即可構建查詢。

使用查詢生成器

首次訪問查詢生成器時，界面頂部顯示的 URL 默認為附加了您分配的 API 密鑰的 API 的 URL。在您構建查詢時，URL 會更改以反映您的選擇。

查詢生成器屏幕還會顯示為您當前會話生成的 API 密鑰。此密鑰自上次使用后 60 分鐘內有效。

Eggplant Monitoring Insights Query Builder 中的 API 鍵字段

如果在您嘗試選擇測試或數據時查詢生成器變得無響應，則您的密鑰可能已過期。嘗試刷新屏幕。如果顯示 401 身份驗證失敗消息，則密鑰已過期，您需要再次登錄 API 以生成新密鑰。

指定測試過濾器

測試過濾器是查詢生成器界面左側的字段。這些過濾器允許您定義您感興趣的監控測試。請注意，您選擇的條件越具體，查詢運行的速度就越快。

單擊參數可在單個頁面上顯示所有可用過濾器及其說明。

查詢過濾器字段

查詢生成器為您的查詢提供了廣泛的過濾選項。下面描述的選項是最基本的選擇。

帳戶ID：必需。選擇您希望從中查看數據的監控帳戶。此下拉菜單中顯示的帳戶是您有權訪問的帳戶。您可以選擇單個或多個帳戶。

身份證：必填。選擇您希望從中查看數據的監視器。此下拉列表中顯示的監視器包含在AccountId下拉列表中選擇的帳戶中。您必須在AccountId字段中至少選擇一個帳戶才能填充Id下拉列表。您可以選擇可用監視器的任意組合。對于具有多個步驟的監視器（例如，用戶旅程），您可以選擇單個步驟，以便查詢僅返回這些步驟的數據。

注意：如果您選擇了一個帳戶，但Id下拉列表沒有顯示任何選項，則可能是您的公司尚未設置 API 查詢限額。要驗證這一點，請退出 API 并嘗試再次登錄，此時如果您的限額尚未設置，您將收到通知。在這種情況下，請聯系您的客戶經理或客戶支持。

StartDate：指定要檢索的測試數據的開始日期，可以采用 yyyy-mm-dd 格式或使用日期選擇器。如果不指定開始日期，則查詢默認為 7 天前的日期。

EndDate：以 yyyy-mm-dd 格式或使用日期選擇器指定要檢索的測試數據的結束日期。如果未指定結束日期，則查詢默認為當前日期。

LimitTestResults：指定要返回的最大測試結果數。默認值為 20。使用默認值或將其設置得更低，以便您的查詢盡快運行。

格式：指定返回數據的格式。從 XML、JSON、PHP 或 YAML 中進行選擇。XML 是默認設置。

還有更多過濾器可用于進一步縮小結果范圍。查詢生成器 UI 文本定義了這些過濾器。

指定數據過濾器

使用返回下拉列表選擇要在響應中返回的測試數據。與測試過濾器字段一樣，較小的數據集會減少響應的大小并提高查詢的性能，因此請盡可能具體。

Eggplant Monitoring Insights 查詢生成器中的返回過濾器下拉列表

下拉列表是Eggplant Monitoring Insights平臺數據結構的動態生成表示。頁面監視器的測試結果的數據結構與用戶旅程的數據結構不同，因此根據您在查詢中包含的測試過濾器，樹看起來不同。請注意，如果您更改查詢中的監視器類型，則會重新生成樹，因此您選擇的項目可能會丟失。此外，樹的某些分支僅在它們包含數據時才顯示，因此，例如，如果您為查詢指定一個未運行測試的日期范圍，則與測試結果數據相關的樹的分支不會出現.

該 API 旨在讓您訪問監控平臺上的所有數據，因此可用數據過濾器的數量非常廣泛。熟悉監控門戶和那里可用的數據可以使 API 查詢的數據過濾器選擇合乎邏輯和直觀。盡管如此，樹結構的幾個關鍵方面值得強調：

? 在主Account節點下是不同類型的監控器的單獨分支，例如頁面監控器、用戶旅程和 Web 服務監控器。

? 對于用戶旅程和 Web 服務監視器，樹的下一個級別提供監視器級別的信息，即屬于UserJourneys的UserJourney節點。在這個監視器級節點中有一個Steps節點，它保存監視器所測試的每個單獨頁面的數據。所述的結構的步驟節點是到的結構基本相同的頁節點，其中包含用于單頁監視器的數據。

? 在監視器級別和頁面級別，有TestResults和TestingSummary節點。TestResults包含與特定測試相關的信息，而TestingSummary可以提供標準時間段內的平均數據，或者僅提供與上次運行的測試相關的數據。摘要數據可能特別有用，具體取決于您的業務需求。

讀取查詢響應

構建查詢后，單擊查詢字符串預覽區域中的 URL 以運行查詢。這將打開一個新選項卡或窗口，具體取決于您的瀏覽器，顯示查詢結果。您可以在查詢編譯過程中的任何時候單擊 URL 并不斷優化查詢，直到返回的數據符合您的確切要求。

每個查詢都會產生一個明確定義它是否成功的響應。所述<響應>元件（或它的等效非XML格式）包含此信息。如果查詢成功，該元素顯示如下：

<SiteConfidenceApi Version="current">
<Request/>
<Response Status="Ok" Code="200" Message="Success.">
</Response>
</SiteConfidenceApi>