本エンドポイントでは、KPIデータの一覧を取得できます。企業・業界・セグメントを指定して一覧をフィルターすることもできます。
【リクエスト】
-
メソッド: POST
-
パス: /innovation/v1/kpis/bulkLookup
クエリパラメータ
| パラメータ名 |
省略可否 |
説明 |
| size |
可 |
ページサイズを指定します。1~100の範囲で指定してください。 デフォルト値は20です。 |
| page |
可 |
取得するページ番号を指定します。0以上の値を指定してください。 デフォルト値は0です。 |
リクエストボディ
| フィールド名 |
省略可否 |
説明 |
| companyIds |
可 |
絞り込み対象のcompanyIdを指定します。配列にはnumber型の値を列挙します。 |
| industryIds |
可 |
絞り込み対象のindustryIdを指定します。配列にはnumber型の値を列挙します。industryIdの取得方法は下記ページをご覧ください。
|
| segmentIds |
可 |
絞り込み対象のsegmentIdを指定します。配列にはnumber型の値を列挙します。segmentIdの取得方法は下記ページをご覧ください。
|
リクエストボディ例
{
"companyIds": [1, 2, 3],
"industryIds": [48],
"segmentIds": [1031, 1032]
}
レート制限
分間300リクエストを上限に設定しています。
【レスポンス】
ステータスコード
| コード |
説明 |
| 200 |
リクエスト成功 |
| 400 |
リクエストパラメータが不正 |
| 401 |
認証失敗 |
| 429 |
レート制限 |
| 500 |
不明なエラー |
レスポンスボディ
| フィールド名 |
型 |
説明 |
| page |
object |
ページに関する情報です。Page型のオブジェクトです。 |
| data |
array |
KPIデータの一覧です。配列にはKpiResponse型のオブジェクトが列挙されます。 |
| fullRecordCount |
number |
フィルター条件に一致するKPIデータの総数です。 |
Page 定義
| フィールド名 |
型 |
説明 |
| totalElements |
number |
フィルター条件に一致するKPIデータの総数です。 |
| totalPages |
number |
ページの総数です。 |
| hasNext |
boolean |
次のページが存在するかを表します。 |
| hasPrevious |
boolean |
前のページが存在するかを表します。 |
| isLast |
boolean |
最後のページであるかを表します。 |
| isFirst |
boolean |
最初のページであるかを表します。 |
| current |
object |
現在のページに関する情報です。PageInfo型のオブジェクトです。 |
| previous |
object |
前のページに関する情報です。PageInfo型のオブジェクトです。 |
| next |
object |
次のページに関する情報です。PageInfo型のオブジェクトです。 |
PageInfo 定義
| フィールド名 |
型 |
説明 |
| pageNumber |
number |
ページ番号です。 |
| pageSize |
number |
ページあたりのデータ件数です。 |
KpiResponse 定義
| フィールド名 |
型 |
説明 |
| companyId |
number |
イノベーションプレイヤーのIDです。 |
| productName |
string |
イノベーションプレイヤーの名称です。 |
| industryId |
number |
イノベーションプレイヤーが所属するイノベーションインダストリーのIDです。 |
| industryName |
string |
イノベーションプレイヤーが所属するイノベーションインダストリーの名称です。 |
| segmentName |
string |
イノベーションインダストリーに属するセグメントの名称です。 |
| segmentId |
number |
イノベーションインダストリーに属するセグメントのIDです。 |
| sectorName |
string |
イノベーションインダストリーに関連するセクターの名称です。 |
| kpis |
array |
KPIの一覧です。配列にはKpi型のオブジェクトが列挙されます。 |
Kpi 定義
| フィールド名 |
型 |
説明 |
| key |
string |
KPIの指標名です。 |
| value |
string |
KPIの内容です。 |
| type |
string |
KPIの種別です。COMPANY_SPECIFIC または INDUSTRY_SPECIFIC が返されます。 |
コメント
0件のコメント
サインインしてコメントを残してください。