首頁(yè) > 產(chǎn)品中心 
Eggplant Monitoring InsightsAPI主要是一個(gè)數(shù)據(jù)提取工具，允許用戶(hù)通過(guò)在格式標(biāo)準(zhǔn)HTTP請(qǐng)求，如XML，JSON，PHP或YAML直接訪問(wèn)和提取物的測(cè)試結(jié)果。API 數(shù)據(jù)請(qǐng)求可用于從報(bào)告電子表格到實(shí)時(shí)報(bào)告應(yīng)用程序的任何內(nèi)容。API 是推薦的高級(jí)Eggplant監(jiān)控洞察客戶(hù)導(dǎo)入實(shí)時(shí)和歷史數(shù)據(jù)的解決方案。
API基礎(chǔ)
您以HTTP請(qǐng)求的形式向Eggplant Monitoring Insights API進(jìn)行查詢(xún)。使用 API 用戶(hù)界面設(shè)計(jì)和微調(diào)您的查詢(xún)。根據(jù)您的要求，您可以根據(jù)需要手動(dòng)運(yùn)行此查詢(xún)，也可以構(gòu)建應(yīng)用程序以編程方式調(diào)用該查詢(xún)。如果需要，您可以設(shè)計(jì)您的應(yīng)用程序以進(jìn)一步優(yōu)化提取的數(shù)據(jù)，并以適合您的確切需求的格式呈現(xiàn)它。
要使用 API 用戶(hù)界面：
? 在https://api.mon.eggplant.cloud訪問(wèn)API用戶(hù)界面。
? 使用您的標(biāo)準(zhǔn)用戶(hù)名和密碼登錄。Eggplant Monitoring Insights生成一個(gè) API 密鑰來(lái)驗(yàn)證您的會(huì)話。
? 構(gòu)建您的查詢(xún)。
? 運(yùn)行您的查詢(xún)。
? 檢查以查看查詢(xún)是否返回所需的數(shù)據(jù)。
? （可選）修改并重新運(yùn)行您的查詢(xún)，直到它返回您需要的數(shù)據(jù)。
API 密鑰
如上所述，在您登錄用戶(hù)界面后，API 使用密鑰來(lái)維護(hù)您的會(huì)話。密鑰對(duì)于每個(gè)會(huì)話都是唯一的，并且是發(fā)送到 API 的查詢(xún) URL 的重要組成部分。
自上次使用后，該密鑰的有效期為 60 分鐘。這意味著如果密鑰每 59 分鐘至少使用一次，會(huì)話可以無(wú)限期地持續(xù)。如果密鑰過(guò)期，請(qǐng)注銷(xiāo)然后重新登錄以重新進(jìn)行身份驗(yàn)證并生成新密鑰。
注意：如果帳戶(hù)對(duì) API 的訪問(wèn)權(quán)限過(guò)期或被刪除，API 密鑰將自動(dòng)過(guò)期。如果這種情況意外發(fā)生，請(qǐng)聯(lián)系您的客戶(hù)經(jīng)理或支持人員。
您可以使用瀏覽器中的 URL 請(qǐng)求強(qiáng)制密鑰過(guò)期。例如，如果您被分配了密鑰abcdefghijklmnopqrstuvwxyz123456并需要強(qiáng)制它過(guò)期，則 URL 請(qǐng)求將是：
https://api.mon.eggplant.cloud/current/abcdefghijklmnopqrstuvwxyz123456/Logout
使用查詢(xún)生成器
為了從 API 返回您需要的特定數(shù)據(jù)，查詢(xún) URL 需要包含過(guò)濾結(jié)果數(shù)據(jù)的值。在查詢(xún)生成器 UI 中，您可以為所需數(shù)據(jù)選擇過(guò)濾器。然后，查詢(xún)構(gòu)建器工具會(huì)為您構(gòu)建正確的查詢(xún) URL。
訪問(wèn)查詢(xún)生成器
轉(zhuǎn)到位于https://api.mon.eggplant.cloud的 API 用戶(hù)界面起始頁(yè)面，并使用您的Eggplant Monitoring Insights用戶(hù)名和密碼登錄。您的 API 密鑰在您登錄時(shí)生成。
注意： 您必須擁有與您的用戶(hù)帳戶(hù)關(guān)聯(lián)的 API 權(quán)限才能訪問(wèn) API。如果您不確定您的帳戶(hù)是否具有 API 權(quán)限，請(qǐng)聯(lián)系您的客戶(hù)經(jīng)理。
登錄后，單擊Query Builder下的current以打開(kāi) Query Builder UI。
查詢(xún)生成器將在新選項(xiàng)卡或窗口中打開(kāi)，具體取決于您的瀏覽器設(shè)置。
注意：如果您在API 直接調(diào)用下選擇當(dāng)前，您將獲得一個(gè) API 密鑰，并且無(wú)需查詢(xún)生成器的幫助即可構(gòu)建查詢(xún)。
使用查詢(xún)生成器
首次訪問(wèn)查詢(xún)生成器時(shí)，界面頂部顯示的 URL 默認(rèn)為附加了您分配的 API 密鑰的 API 的 URL。在您構(gòu)建查詢(xún)時(shí)，URL 會(huì)更改以反映您的選擇。
查詢(xún)生成器屏幕還會(huì)顯示為您當(dāng)前會(huì)話生成的 API 密鑰。此密鑰自上次使用后 60 分鐘內(nèi)有效。
Eggplant Monitoring Insights Query Builder 中的 API 鍵字段
如果在您嘗試選擇測(cè)試或數(shù)據(jù)時(shí)查詢(xún)生成器變得無(wú)響應(yīng)，則您的密鑰可能已過(guò)期。嘗試刷新屏幕。如果顯示 401 身份驗(yàn)證失敗消息，則密鑰已過(guò)期，您需要再次登錄 API 以生成新密鑰。
指定測(cè)試過(guò)濾器
測(cè)試過(guò)濾器是查詢(xún)生成器界面左側(cè)的字段。這些過(guò)濾器允許您定義您感興趣的監(jiān)控測(cè)試。請(qǐng)注意，您選擇的條件越具體，查詢(xún)運(yùn)行的速度就越快。
單擊參數(shù)可在單個(gè)頁(yè)面上顯示所有可用過(guò)濾器及其說(shuō)明。
查詢(xún)過(guò)濾器字段
查詢(xún)生成器為您的查詢(xún)提供了廣泛的過(guò)濾選項(xiàng)。下面描述的選項(xiàng)是最基本的選擇。
帳戶(hù)ID：必需。選擇您希望從中查看數(shù)據(jù)的監(jiān)控帳戶(hù)。此下拉菜單中顯示的帳戶(hù)是您有權(quán)訪問(wèn)的帳戶(hù)。您可以選擇單個(gè)或多個(gè)帳戶(hù)。
身份證：必填。選擇您希望從中查看數(shù)據(jù)的監(jiān)視器。此下拉列表中顯示的監(jiān)視器包含在AccountId下拉列表中選擇的帳戶(hù)中。您必須在AccountId字段中至少選擇一個(gè)帳戶(hù)才能填充Id下拉列表。您可以選擇可用監(jiān)視器的任意組合。對(duì)于具有多個(gè)步驟的監(jiān)視器（例如，用戶(hù)旅程），您可以選擇單個(gè)步驟，以便查詢(xún)僅返回這些步驟的數(shù)據(jù)。
注意：如果您選擇了一個(gè)帳戶(hù)，但I(xiàn)d下拉列表沒(méi)有顯示任何選項(xiàng)，則可能是您的公司尚未設(shè)置 API 查詢(xún)限額。要驗(yàn)證這一點(diǎn)，請(qǐng)退出 API 并嘗試再次登錄，此時(shí)如果您的限額尚未設(shè)置，您將收到通知。在這種情況下，請(qǐng)聯(lián)系您的客戶(hù)經(jīng)理或客戶(hù)支持。
StartDate：指定要檢索的測(cè)試數(shù)據(jù)的開(kāi)始日期，可以采用 yyyy-mm-dd 格式或使用日期選擇器。如果不指定開(kāi)始日期，則查詢(xún)默認(rèn)為 7 天前的日期。
EndDate：以 yyyy-mm-dd 格式或使用日期選擇器指定要檢索的測(cè)試數(shù)據(jù)的結(jié)束日期。如果未指定結(jié)束日期，則查詢(xún)默認(rèn)為當(dāng)前日期。
LimitTestResults：指定要返回的最大測(cè)試結(jié)果數(shù)。默認(rèn)值為 20。使用默認(rèn)值或?qū)⑵湓O(shè)置得更低，以便您的查詢(xún)盡快運(yùn)行。
格式：指定返回?cái)?shù)據(jù)的格式。從 XML、JSON、PHP 或 YAML 中進(jìn)行選擇。XML 是默認(rèn)設(shè)置。
還有更多過(guò)濾器可用于進(jìn)一步縮小結(jié)果范圍。查詢(xún)生成器 UI 文本定義了這些過(guò)濾器。
指定數(shù)據(jù)過(guò)濾器
使用返回下拉列表選擇要在響應(yīng)中返回的測(cè)試數(shù)據(jù)。與測(cè)試過(guò)濾器字段一樣，較小的數(shù)據(jù)集會(huì)減少響應(yīng)的大小并提高查詢(xún)的性能，因此請(qǐng)盡可能具體。
Eggplant Monitoring Insights 查詢(xún)生成器中的返回過(guò)濾器下拉列表
下拉列表是Eggplant Monitoring Insights平臺(tái)數(shù)據(jù)結(jié)構(gòu)的動(dòng)態(tài)生成表示。頁(yè)面監(jiān)視器的測(cè)試結(jié)果的數(shù)據(jù)結(jié)構(gòu)與用戶(hù)旅程的數(shù)據(jù)結(jié)構(gòu)不同，因此根據(jù)您在查詢(xún)中包含的測(cè)試過(guò)濾器，樹(shù)看起來(lái)不同。請(qǐng)注意，如果您更改查詢(xún)中的監(jiān)視器類(lèi)型，則會(huì)重新生成樹(shù)，因此您選擇的項(xiàng)目可能會(huì)丟失。此外，樹(shù)的某些分支僅在它們包含數(shù)據(jù)時(shí)才顯示，因此，例如，如果您為查詢(xún)指定一個(gè)未運(yùn)行測(cè)試的日期范圍，則與測(cè)試結(jié)果數(shù)據(jù)相關(guān)的樹(shù)的分支不會(huì)出現(xiàn).
該 API 旨在讓您訪問(wèn)監(jiān)控平臺(tái)上的所有數(shù)據(jù)，因此可用數(shù)據(jù)過(guò)濾器的數(shù)量非常廣泛。熟悉監(jiān)控門(mén)戶(hù)和那里可用的數(shù)據(jù)可以使 API 查詢(xún)的數(shù)據(jù)過(guò)濾器選擇合乎邏輯和直觀。盡管如此，樹(shù)結(jié)構(gòu)的幾個(gè)關(guān)鍵方面值得強(qiáng)調(diào)：
? 在主Account節(jié)點(diǎn)下是不同類(lèi)型的監(jiān)控器的單獨(dú)分支，例如頁(yè)面監(jiān)控器、用戶(hù)旅程和 Web 服務(wù)監(jiān)控器。
? 對(duì)于用戶(hù)旅程和 Web 服務(wù)監(jiān)視器，樹(shù)的下一個(gè)級(jí)別提供監(jiān)視器級(jí)別的信息，即屬于UserJourneys的UserJourney節(jié)點(diǎn)。在這個(gè)監(jiān)視器級(jí)節(jié)點(diǎn)中有一個(gè)Steps節(jié)點(diǎn)，它保存監(jiān)視器所測(cè)試的每個(gè)單獨(dú)頁(yè)面的數(shù)據(jù)。所述的結(jié)構(gòu)的步驟節(jié)點(diǎn)是到的結(jié)構(gòu)基本相同的頁(yè)節(jié)點(diǎn)，其中包含用于單頁(yè)監(jiān)視器的數(shù)據(jù)。
? 在監(jiān)視器級(jí)別和頁(yè)面級(jí)別，有TestResults和TestingSummary節(jié)點(diǎn)。TestResults包含與特定測(cè)試相關(guān)的信息，而TestingSummary可以提供標(biāo)準(zhǔn)時(shí)間段內(nèi)的平均數(shù)據(jù)，或者僅提供與上次運(yùn)行的測(cè)試相關(guān)的數(shù)據(jù)。摘要數(shù)據(jù)可能特別有用，具體取決于您的業(yè)務(wù)需求。
讀取查詢(xún)響應(yīng)
構(gòu)建查詢(xún)后，單擊查詢(xún)字符串預(yù)覽區(qū)域中的 URL 以運(yùn)行查詢(xún)。這將打開(kāi)一個(gè)新選項(xiàng)卡或窗口，具體取決于您的瀏覽器，顯示查詢(xún)結(jié)果。您可以在查詢(xún)編譯過(guò)程中的任何時(shí)候單擊 URL 并不斷優(yōu)化查詢(xún)，直到返回的數(shù)據(jù)符合您的確切要求。
每個(gè)查詢(xún)都會(huì)產(chǎn)生一個(gè)明確定義它是否成功的響應(yīng)。所述<響應(yīng)>元件（或它的等效非XML格式）包含此信息。如果查詢(xún)成功，該元素顯示如下：
<SiteConfidenceApi Version="current">
<Request/>
<Response Status="Ok" Code="200" Message="Success.">
</Response>
</SiteConfidenceApi>
