概要
Insight API は、下記のページに記載のある方法などで、API実行時に認証を行う必要があります。
APIをPythonやJavaなどで実行するのではなく、HTTPプロトコルのみで結果を取得したいというご要望がある場合には、Persited APIを利用します。
Persited APIでは、事前に下記を定義します。
-
Analytics APIのパス名 (例: /traffic や /profile/content/push など)
-
どのパラメータを動的に設定可能にするか (例：siteId, start, filtersなど）
登録されたAPIは、認証なしにREST形式にて実行できます。
REST形式のAPIを実行するには、事前登録した際に得られるIDを指定する必要があります。
また、APIのパラメーターをURLパラメーターとして設定することにより、リクエストごとに設定することも可能です。
Persisted APIは、２種類の方法で管理が可能です。
-
APIを利用して管理する方法
下記に記述があります。利用方法は、/persistedに記述がありますが、UIで管理できる方法があるため省略します。
-
UIを利用して管理する方法
以降で説明したします。
UIを利用して管理する方法
例として、下記のAPIをストアードAPIとして登録する手順について
記述いたします。それぞれ、必要なAPIとして読み替えて下さい。
※登録するためにはそのユーザアカウントに persistedRequestOwner の権限が必要です。
権限付与は貴社の管理権限を持つ方にご依頼ください。
例：サイト内の記事の１時間のトップランキングを取得するAPI
$ python cx.py /traffic/event '{"start":"-1h","siteIds":["siteID_A"], "groups":["url"], "filters":[{"type":"keyword","group":"pageclass","item":"article"}]}'
手順１
まずは、実行したいAPIを正常に実行できるかどうかを通常のInsight APIを実行して
与えた引数で正常に結果が帰ってくるか（エラーが出ないか）を確かめて下さい。
手順2
InsightのGUIへアクセスします。
手順３
ログイン後、画面上部にある「Admin」をクリックします。
手順４
APIをクリックします。
手順５
「Create a new persisted request」をクリックします。
手順６
下記に実行したいAPIを入力します。各項目の詳細は、以下で説明いたします。
※ Path: 実行するAPIを指定します。下記から選択ができます。
※ Request data: APIで利用するパラメーターを入力します。入力例は下記をご参照ください。
※ Mutable fields: パラメーター名を指定します。この設定は、実行リクエストごとに変更できるパラメーターを指定します。例えば、startをここで指定すると、実行リクエストごとにstartの値を指定できます。
例: 「groups」をmutable fieldsとして登録することにより、ストアードAPIを実行時のパラメーターで、deviceTypeなどの任意のgroupsを指定することができます。
※ Description: このストアードクエリの概要を入力します。複数のストアードクエリを登録する際には、あとからすぐにAPIの用途が区別ができるので入力することをオススメいたします。
手順７
手順６の各項目を設定後、「Save changes」を押すと保存されます。設定後、各クエリのID列に赤枠の用のような値が設定されます。
実行方法
手順8
ストアードAPIを実行します。パラメータでは、手順７のIDを入力します。結果はJSON形式で返却されます。
https://api.cxense.com/persisted/execute?persisted=57d4ffc6f9f9f3505af12d4fe90374632dda8ca2
※ 上記IDは実行例ですので実在しません。
手順９
もし、startを-1hから-2hに変更したい場合には、下記にアクセスします。
https://api.cxense.com/persisted/execute?persisted=57d4ffc6f9f9f3505af12d4fe90374632dda8ca2&json={"start":"-2h"}
※ ここで変更（上書き）できるパラメーターは、手順６のMutable fieldsに設定したパラメーターのみです。
※ 上記IDは実行例ですので実在しません。