Web REST API 範例

簡介

Web REST API ,可用來針對收集的資料執行查詢,以及配置新的網站。

請勿混淆 Web REST API 與 JavaScript 代理程式 API。 JavaScript 代理程式 API 會顯示受監視網站上可用的 API。 您的網站可以與 JavaScript 代理程式的 API 互動,以強化或配置所收集的資料、傳送自訂事件等等。

此頁面提供網站監視相關的 Web REST API 範例。 請參閱一般 Web REST API 文件,以瞭解鑑別、速率限制、術語、使用慣例等基本概念。 此外,此頁面還顯示如何使用 Instana 的使用者介面來存取相同的資料 (可能的話)。

列出所有支援的網站監視度量值

目前, Instana 使用者介面不容許檢驗所有可能的度量值。 只有 Web REST API 呼叫可用來列出所有網站監視度量值。

curl -H "Authorization: apiToken $API_TOKEN" \
  "https://$UNIT-$TENANT.instana.io/api/website-monitoring/catalog/metrics?pretty"

列出所有支援的網站監視標籤

使用者介面

您可以按一下 所有過濾器分組方式,以查看網站監視分析區域內可用的分組及過濾標籤。

Instana 使用者介面內的可用標籤

Web REST API

curl -H "Authorization: apiToken $API_TOKEN" \
  "https://$UNIT-$TENANT.instana.io/api/website-monitoring/catalog/tags?pretty"

活動細分 (依國家/地區)

使用者介面

網站監視分析視圖可以提供此資訊。 透過 beacon.geo.country 來達成此群組,同時選擇性地過濾使用 beacon.website.name的特定網站。 接下來,配置您感興趣的度量值。 在您選取的畫面擷取內,您可以看到頁面載入總數、唯一使用者及唯一階段作業。

Instana 使用者介面內的國家/地區活動明細

Web REST API

curl -X POST \
  -H 'Content-Type: application/json' \
  -H "Authorization: apiToken $API_TOKEN" \
  "https://$UNIT-$TENANT.instana.io/api/website-monitoring/analyze/beacon-groups?pretty" \
  -d '
{
  "type": "PAGELOAD",
  "group": {
    "groupbytag": "beacon.geo.country"
  },
  "metrics": [
    {
      "metric": "uniqueUsers",
      "aggregation": "DISTINCT_COUNT"
    },
    {
      "metric": "uniqueSessions",
      "aggregation": "DISTINCT_COUNT"
    },
    {
      "metric": "pageLoads",
      "aggregation": "SUM"
    }
  ],
  "pagination": {
    "retrievalSize": 200
  },
  "order": {
    "by": "uniqueSessions",
    "direction": "DESC"
  },
  "tagFilters": [
    {
      "name": "beacon.website.name",
      "value": "Robotshop",
      "operator": "equals"
    }
  ],
  "timeFrame": {
    "windowSize": 604800000
  }
}
'

自訂地理 IP 對映

可以透過 Web Rest API 或使用者介面來新增自訂地理 IP 對映。 如需範例,請參閱 自訂地理詳細資料配置