フォローする

Cxense Insight API の概要

下記のAPIを利用して、データの入出力等を行うことができます。また、各APIは、記載されているパス(Path)を指定して実行します。パス毎にAPIのグループ分けを行っています。

パス(Path)
概要
/persisted

API実行時に、Python などを利用せず、HTTPリクエストのみで実行したい場合に利用します。

 事前に、どのAPIを利用して、どのフィールドを動的にパラメータで変更できるかを指定するために、Persisted リクエストを作成します。

APIの認証の代わりに、事前に登録したPersistedリクエストのidを指定してHTTPでアクセスを行います。

/persisted

登録したPersistedリクエストの情報取得します。

/persisted/create

Persisted リクエストを登録します。

/persisted/update

Persisted リクエストを更新します。

/persisted/delete

Persisted リクエストを削除します。
/persisted/execute Persisted リクエストを実行します。
   
/processing

辞書のカスタマイズなどを行うAPI

例:Cxense Searchの同義語辞書など

/processing/dictionary/read 辞書データを取得します。

/processing/dictionary/create

辞書データを作成します。

/processing/dictionary/delete

辞書データを削除します。

/processing/dictionary/update

辞書データの新規アップロードならびに更新を行います。辞書データは、Excelのワークブックとなります。

/processing/dictionary/undo

辞書データを以前のデータに戻します。
/processing/linguistics/execute 入力したテキストデータのコンテンツプロファイルを取得します。
   
/profile/content コンテンツプロファイルに関連するAPI
/profile/content/external/delete 指定したURLパターンで、コンテンツプロファイルへメタデータを付与する設定を削除します。
/profile/content/external/deleteAll

URLパターンで、コンテンツプロファイルへメタデータを付与する設定を全て削除します。

/profile/content/external/read 指定したURLパターンで、コンテンツプロファイルへメタデータを付与する設定を取得します。
/profile/content/external/readAll

URLパターンで、コンテンツプロファイルへメタデータを付与する設定を全て取得します。

/profile/content/external/update URLパターンで、コンテンツプロファイルへメタデータを付与する設定を追加・更新します。
/profile/content/fetch 指定したURLのコンテンツプロファイルを取得します。
/profile/content/push 指定したURLを再クロールします。
/profile/content/related 指定したキーワードの関連語を取得します。
   
/profile/user ユーザープロファイルに関連するAPI
/profile/user 指定したユーザーのプロファイルを取得します。
/profile/user/external/update 指定したユーザーに外部データを付与します。
/profile/user/external/read 指定したユーザーに付与された外部データを取得します。

/profile/user/external/delete

指定したユーザーに付与された外部データを削除します。

/profile/user/external/link 指定した1st パーティクッキー(ckp)と紐づけされた外部IDを取得します。
/profile/user/external/link/update 指定した1st パーティクッキー(ckp)と指定した外部IDを紐づけします。

 

 
/public 認証時に利用するAPI(認証不要)
/public/date 認証ヘッダーに利用するための現在時刻を取得します。
   
/site サイトとサイトグループに関するAPI

/site

サイトの情報を取得します。
/site/create サイトの作成します。

/site/update

既存のサイトを更新します。

/site/group

サイトグループの情報を取得します。

/site/group/create

サイトグループを作成します。

/site/group/update

既存のサイトグループの更新をします。
   
/traffic

各種トラフィック情報を取得するAPIとなります。

各API共通で、集計期間(開始日時、終了日時)とフィルター(絞り込み条件)を設定します。

 

集計期間

31日前まで指定することができます。別途オプションとなりますが、期間を延ばすことができます。

 

フィルター

下記の種類のフィルターがあります。詳細については、Traffic filters をご参照下さい。

1. イベントフィルター:

アクセス元のクライアントから取得できる情報を元にしたフィルターです。/traffic/event/describe で取得できるグループを利用できます。例えば、特定のURLやデバイスの種別などで絞り込めます。

2. キーワードフィルター:

各ページのプロファイル情報を元にしたフィルターです。/traffic/keyword/describe で取得できるグループを利用できます。例えば、特定のキーワードやカスタムのメタタグなどでの絞り込めます。

3. カスタムフィルター:

カスタムパラメータを元にしたフィルターです。

/traffic/custom/describe で取得できるグループを利用できます。

4.ユーザーインタレストフィルター:

興味のあるカテゴリの情報を元にしたフィルターです。事前に興味のあるカテゴリーの定義を事前に行う必要があります。

5. 滞在時間フィルター:

滞在時間を元にしたフィルターです。

6. ユーザーフィルター:

何PV以上のユーザーや5から10個のページを参照したユーザーなど、ユーザー毎のトラフィックに応じたフィルターです。

7. ユーザーの行動履歴フィルター:

ある特定のURLにアクセスしたユーザーという条件でフィルターしたい際に利用します。これを利用することで、ある特定のURLにアクセスしたユーザーが他にもアクセスしたページや、特定のページにアクセスする前にアクセスしていたページの一覧などを取得することができます。

8. 時間フィルター:

各フィルターを適用する期間を追加付与できます。例えば、2日以内にデスクトップでアクセスしたイベントのみを対象とできます。

9. ブーリアンフィルター:

ANDやNOTやOR条件を入れ子で柔軟に指定できます。

/traffic

集計されたトラフィックデータを取得します。

指定された条件に合致するPV,UU,訪問数,平均滞在時間,ページ数,離脱数,直帰数を取得したい場合に利用します。

/traffic/event

集計されたトラフィックデータのトップリストを取得します。

例えば、指定された条件に合致するトップ100のURL毎のPV,UU,訪問数,平均滞在時間,ページ数,離脱数,直帰数を取得したい場合などに利用します。

URLの他にも/traffic/event/describe で取得できるグループを指定することができます。

/traffic/event/describe

/traffic/event で利用可能なグループ名を調べたい時に利用します。

実行することで、/traffic/event で利用可能なグループ名の一覧を取得できます。

/traffic/keyword

アクセスされたページのコンテンツプロファイルに含まれる各グループのトップリストを取得します。

例えば、指定した期間内にアクセスされたページから抽出されたキーワード(コンセプト)の一覧を取得することができます。

抽出されたキーワード以外にも、/traffic/keyword で取得できるグループを指定することができます。 

/traffic/keyword/describe

/traffic/keyword で利用可能なグループ名を調べたい時に利用します。

実行することで、/traffic/keyword で利用可能なグループ名の一覧を取得します。

/traffic/custom

集計されたカスタムパラメータのトップリストを取得します。

カスタムパラメーターを利用してトラフィックデータを収集している場合には、利用しているカスタムパラメーター毎のPV,UU,訪問数,平均滞在時間,ページ数,離脱数,直帰数を取得できます。

/traffic/custom/describe

/traffic/custom で利用可能なグループ名を調べたい時に利用します。

実行することで、/traffic/custom で利用可能なグループ名を取得します。

この場合、設定しているカスタムパラメータのグループ名の一覧が取得できます。

/traffic/compare

異なるフィルターでの集計データを比較します。

デスクトップでのTOP10のURLならびにそのPV数を取得して、同時に、それらのURLに対してスマートフォンでのPV数を取得したい場合に利用します。

/traffic/related

指定したページと、関連しているページを取得したい場合に利用します。このページをみている他のユーザーもよく見ているページを取得できます。

/traffic/user

アクセスのあったユーザーの外部ID(貴社会員IDなど)を取得できます。ただし、事前に外部ユーザーIDと1stパーティクッキーの紐づけを行う必要があります。

/traffic/user/interest

ユーザーの興味のあるカテゴリーのトップリストを取得します。

ただし、興味のあるカテゴリーの定義を事前に行う必要があります。 

/traffic/user/keyword

ユーザーのセグメンテーションや自宅や仕事場などのローケション毎のPV数やユニークユーザー数を取得できます。

セグメンテーションを作成するには、Cxense DMPの契約が必要となります。

/traffic/user/external

外部データとして/profile/user/external/update で追加登録された各データ毎のトラフィックデータを取得します。

例えば、外部データとして年齢を設定した場合には、年齢毎のPV

やUUを取得することができます。

/traffic/user/histogram

各ユーザーのPV数毎のユニークユーザー数の分布情報を取得できます。

これを利用して、サイト内で各ユーザがどのくらいのPVをあげているかがわかります。

/traffic/user/histogram/event

各ユーザーが、指定したグループ(/traffic/event/describeで取得した)のデータをいくつ持っているかに関しての分布情報を取得できます。

例えば、各ユーザーのデバイス数の分布情報を取得できます。

 

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

コメント

Powered by Zendesk