1. 呼叫方法

API 採用標準的 HTTP 方式，呼叫的 URL 為:

http://$WEB_URL/api/$API_URL?token=$API_SECRET&project=$PROJECT

其中 $WEB_URL 即網站的 URL，$API_URL 則表示具體的 API，如果使用神策分析 Cloud 服務，則對應的 URL 為:

http://{$service_name}.cloud.sensorsdata.cn

如果用戶使用單機版私有部署的神策分析，預設的設定資訊為：

http://{$host_name}:8107

如果用戶使用叢集版私有部署的神策分析，預設的設定資訊如下，其中 host_name 可以是叢集中任意一台機器：

http://{$host_name}:8107

如果私有部署的過程中修改了 Nginx 的預設設定，或透過 CDN 等連接神策分析，則請諮詢相關人員取得設定資訊。

$API_SECRET 用於認證，用於認證，可以使用 admin 帳戶登入系統之後，在右上角點擊用戶名，點擊“權限管理”介面取得（如果是 1.11 及之前的舊版本沒有這個介面，請聯繫技術支援人員取得），1.11 至 1.13 版本取得方式如下圖：

1.15 及之後版本取得 API_Secret 的方式如下圖所示：

修改 admin 帳號的密碼會使 API Secret 發生改變。
1.11 以及之前的系統版本，預設專案的 API Secret 可以連接任意專案的數據；非預設專案的 API Secret 僅能連接該專案的數據；
1.12 版本以及之後的版本，所有專案的 API Secret 僅能連接該專案的數據。
API Secret 和匯入數據使用的 Token 沒有任何關聯。

project 是可選參數，$PROJECT 是 API 操作對應的專案名，預設值為 default，即預設專案。

例如連接 Demo 環境預設專案的事件分析報告的完整網址是:

http://demo.sensorsdata.cn/api/events/report?token=9c283f5711ef03e61e2a67c007100fce

連接 Demo 環境 new_project 專案的事件分析報告的完整網址是:

http://demo.sensorsdata.cn/api/events/report?token=9c283f5711ef03e61e2a67c007100fce&project=new_project

有了網址之後，就可以使用任意 HTTP Client 進行 API 呼叫，例如使用 curl 工具連接 SaaS Demo 的事件分析報告的一個例子如下

curl 'https://saasdemo.cloud.sensorsdata.cn/api/events/report?token=53f48d27f5ed6e701241d7548093274533d0af3d9d2ae80740a629836897900d' \
-H 'Content-Type: application/json' \
--data-binary '{
    "measures":[
        {
            "event_name":"FinalConvert",
            "aggregator":"SUM",
            "field":"event.FinalConvert.contract_value"
        }
    ],
    "unit":"day",
    "by_fields":[
        "event.FinalConvert.product_type"
    ],
    "to_date":"2016-08-14",
    "from_date":"2016-08-14"
}'

CODE

2. 如何快速取得請求參數

因為大部分查詢 API 的參數結構都比較複雜，在使用的時候往往不好組織。這裡建議大家可以透過瀏覽器連接神策分析平台來取得需要的參數。方法如下：

以 Chrome 瀏覽器取得事件分析報告 /events/report 請求參數為例：

1. 打開開發者工具
在瀏覽器中右上角的更多（直立的三個點）——> 更多工具 ——> 開發者工具，或者 MAC 用戶按 option+command+i，Windows 用戶使用 F12 快捷鍵。打開後如圖所示：

2. 在開發者工具中點擊 A 處（Network），進入網路選項。
3. 之後在頁面中按照自己的需求增加任意指標和過濾參數。這時候我們可以看到在 C 處（請求欄）中出現了很多網址選項，這些都是瀏覽器向伺服器發送的請求。
4. 用戶直接點擊相應的請求就可以查看到此次請求所附帶的參數。
如果請求較多不好篩選，可以在 B 處（過濾欄）中輸入所需要的 API 網址 ,如 “/events/report”，進行過濾篩選。