フォローする

REST形式でのInsight APIの実行

概要

Insight API は、下記のページに記載のある方法などで、API実行時に認証を行う必要があります。

Cxnese Insight API認証方法

 

APIをPythonやJavaなどで実行するのではなく、HTTPプロトコルのみで結果を取得したいという

ご要望がある場合には、Persited APIを利用します。

 

Persited APIでは、事前にPersisted クエリとして下記を定義します。

  • Insight APIのパス名 (例: /traffic や /profile/content/push など)
  • どのパラメータを動的に設定可能にするか (例:siteId, start, filtersなど)

登録されたクエリは、認証なしにREST形式にて実行できます。

REST形式のAPIを実行するには、事前登録した際に得られるIDを指定する必要があります。

Persisted クエリは、2種類の方法で管理が可能です。

  1. APIを利用して管理する方法
    下記に記述があります。利用方法は、/persistedに記述がありますが、UIで管理できる方法があるため省略します。

  2. UIを利用して管理する方法
    以降で説明いたします。

UIを利用して管理する方法

 

例として、下記のAPIをPersisted APIとして登録する手順について

記述いたします。それぞれ、実行したいAPIとして読み替えて下さい。

 

例:サイト内の記事の1時間のトップランキングを取得するAPI

python cx.py /traffic/event '{"start":-3600,"siteIds":["siteID_A"], "groups":["url"], "filters":[{"type":"keyword","group":"pageclass","item":"article"}]}'


手順1 

実行したいAPIを正常に実行できるかどうかを通常のInsight APIを実行して

与えた引数で正常に結果が帰ってくるか(エラーが出ないか)を確かめて下さい。

 

手順2

InsightのGUIへアクセスします。

 

手順3

ログイン後、画面上部にある「Admin」をクリックします。

 

手順4

APIをクリックします。

手順5

「Create a stored query」ボタンをクリックします。

 

手順6

下記に実行したいAPIを入力します。各項目の詳細は、以下で説明いたします。

※ Path: 実行するAPIを指定します。下記から選択ができます。

※ Request data: APIで利用するパラメーターを入力します。入力例は下記をご参照ください。

※ Mutable fields: パラメーター名を指定します。この設定は、実行リクエストごとに変更できるパラメーターを指定します。例えば、startをここで指定すると、実行リクエストごとにstartの値を指定できます。

例: 「groups」をmutable fieldsとして登録することにより、ストアードAPIを実行時のパラメーターで、deviceTypeなどの任意のgroupsを指定することができます。

※ Description: このPersisted クエリの概要を入力します。複数のPersisted クエリを登録する際には、あとからすぐにAPIの用途が区別ができるので入力することをオススメいたします。

記述例:

※「siteID_A」は、各自のサイトIDを入力します。

 

手順7

手順6の各項目を設定後、「Store query」を押すと保存されます。設定後、各クエリのID列に赤枠の用のような値が設定されます。

 

手順8

Persisted APIを実行します。パラメータでは、手順7のIDを入力します。結果はJSON形式で返却されます。

https://api.cxense.com/traffic/event?persisted=57d4ffc6f9f9f3505af12d4fe90374632dda8ca2

※ 上記IDは実行例ですので実在しません。

 

手順9

もし、startを-3600から-7200に変更したい場合には、下記にアクセスします。

https://api.cxense.com/persisted/execute?persisted=57d4ffc6f9f9f3505af12d4fe90374632dda8ca2&json={"start":-7200}

※ ここで変更(上書き)できるパラメーターは、手順6のMutable fieldsに設定したパラメーターのみです。

※ 上記IDは実行例ですので実在しません。

他にご質問がございましたら、リクエストを送信してください

コメント

Powered by Zendesk