首页 > 产品中心 
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>
