この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。
このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。
要約タイプ(肯定的、否定的、写真、中立、合計、再投稿)の詳細を指定して、ソーシャル メディア分析(SMA)カウントの要約を取得します。
GET
/api/analytics/v1/sma/summarycounts
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
場所 |
Y |
— |
文字列 |
query |
ソーシャル メディア分析の対象とするロケーション ID。有効な値/形式には、ビルまたはキャンパスのロケーション ID があります。 |
dailyHours |
Y |
— |
文字列 |
query |
時間帯。事前定義された名前で指定します。有効な値/形式は次のとおりです。 |
period |
Y |
— |
文字列 |
query |
対象の期間。事前定義された名前のいずれかで指定します。有効な値/形式は次のとおりです。 |
application/json
要約タイプ(肯定的、否定的、写真、中立、合計、再投稿)の詳細を指定して、SMA カウントの詳細な要約を取得します。
GET
/api/analytics/v1/sma/detailsummarycounts
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
場所 |
Y |
— |
文字列 |
query |
ソーシャル メディア分析の対象とするロケーション ID。有効な値/形式は、ビルまたはキャンパスのロケーション ID です。 |
dailyHours |
Y |
— |
文字列 |
query |
時間帯。事前定義された名前で指定します。有効な値/形式は次のとおりです。 |
period |
Y |
— |
文字列 |
query |
対象の期間。事前定義された名前のいずれかで指定します。有効な値/形式は次のとおりです。 |
summaryType |
Y |
— |
文字列 |
query |
対象とする要約タイプ。事前定義された名前のいずれかで指定します。有効な値/形式は次のとおりです。 |
application/json
要約タイプ(肯定的、否定的、写真、中立、合計、再投稿)の詳細を指定して、すべての SMA カウントの要約を取得します。
GET
/api/analytics/v1/sma/hashtags
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
場所 |
Y |
— |
文字列 |
query |
ソーシャル メディア分析の対象とするロケーション ID。有効な値/形式は、ビルまたはキャンパスのロケーション ID です。 |
period |
Y |
— |
文字列 |
query |
対象の期間。事前定義された名前のいずれかで指定します。有効な値/形式は次のとおりです。 |
application/json
パラメータを格納する JSON 配列が、唯一のパラメータ(本体)です。以下に、JSON 配列に格納されるパラメータについて説明します。
POST
/api/analytics/v1/dwellBreakdown
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
body |
Y |
— |
JSON 配列 |
body |
パラメータが格納された JSON 配列。 |
application/json
{"title":"CMX Error","detail":"period must be in yyyy-MM-dd[;yyyy-MM-dd] format if not one of the predefined types.If passing two dates, they should be in order timeRange must be specified as HH:mm-HH:mm, or 'now' ","httpStatus":500}
パラメータを格納する JSON 配列が、唯一のパラメータ(本体)です。以下に、JSON 配列に格納されるパラメータについて説明します。
JSON 配列に格納されるパラメータ |
説明 |
有効な値/形式 |
---|---|---|
period |
対象の期間。日付範囲または事前定義された名前のいずれかで指定します。 | |
timeRange |
各日で対象とする時間枠。「now」を指定する場合、細分度として指定できるのは、タグ名または階層レベルのみとなります。 |
|
targetArea |
パスの対象とするエリアの ID。 | パスの対象とするエリアの ID。 |
allAreas |
対象とするエリアのリスト。 | エリア ID のカンマ区切りリスト |
granularity |
地理に関する目的の細分度。このパラメータは、「allAreas」にリストされているエリアを、該当するレベルのそれぞれの子孫エリアに置換します。 | 階層レベル |
durationCategories |
ターゲット エリアまたはすべてのエリアについて、デバイスを時間帯で絞り込みます。 | nn-mm 形式の時間。ここで、nn は下限(分単位)、mm は上限(分単位)です。 |
POST
/api/analytics/v1/path
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
body |
Y |
— |
JSON 配列 |
body |
パラメータが格納された JSON 配列。 |
application/json
パラメータを格納する JSON 配列が、唯一のパラメータ(本体)です。以下に、JSON 配列に格納されるパラメータについて説明します。
JSON 配列に格納されるパラメータ |
説明 |
有効な値/形式 |
---|---|---|
granularity |
目的の細分度。上位 n 件の結果(カウントが高い順から n 件の結果)に制限するには [n] を追加し、下位 n 件の結果に制限するには [-n] を追加します。granularity に null を指定すると、エリアでカバーするすべての階層タイプが返されます。 | |
period |
対象の期間。日付範囲または事前定義された名前のいずれかで指定します。 |
|
yAxis |
個々のアクセスについてレポートするか、アクセスをデバイス別に集計するかを指定します(デフォルトでは、デバイスが返されます)。 |
|
timeRange |
各日で対象とする時間枠。「now」を指定する場合、細分度として指定できるのは、タグ名または階層レベルのみとなります。 |
|
aggregate |
細分度で滞留時間を集計するかどうかを指定します。たとえば、個々の日付ではなく、週の各日の合計を表示できます。 |
|
areas |
対象とするエリアのリスト。指定しない場合、すべてのエリアが考慮されます。 | エリア ID のカンマ区切りリスト、または階層レベル |
durationCategories |
特定の時間範囲で滞留時間を分類するかどうかを指定します。 | nn-mm エントリのカンマ区切りリスト。ここで、nn は対象とする滞留時間の下限(分単位)、mm は上限(分単位)です。 |
includeStationary |
固定デバイスを含めるかどうかを指定します(デフォルトは false です)。 |
|
connectionState |
接続されたデバイスまたは検出されたデバイスのどちらかに制限するかどうかを指定します(デフォルトは all です)。 |
|
percentageOf |
このパラメータを設定すると、絶対値ではなく、相対的割合がレポートされます。 | 階層レベル |
areaFilter |
このパラメータを設定すると、フィルタと一致するエリアに結果が絞り込まれます。エリアの選択を絞り込むには、「descendantOf」を使用します。このオプションを使用して、レポートをドリル ダウンします。細分度を絞り込むには、「subsetOf」を使用します。このオプションにより、細分度としてタグが使用されます。 descendantOf の例:キャンパス C1 にゾーン Z1 と Z2 のビル B1 があり、キャンパス C2 にゾーン Z3 のビル B2 があります。この場合、area=Z1,Z2,Z3、granularity=Building、areaFilter=descendantOf:C1 と設定してクエリを実行すると、ビル B1 だけが返されます。 subsetOf の例:タグ T1,T2 は F1 に、T2,T3 は F2 に、T3,T4 は F3 に割り当てられています。この場合、area=F1,F2,F3、granularity=tag、areaFilter=subsetOf:T1,T2 と設定してクエリを実行すると、T1,T2 だけが返されます。 |
|
expandAll |
結果に要素のすべての子孫要素を含めます。 |
|
POST
/api/analytics/v1/manufacturers
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
body |
Y |
— |
JSON 配列 |
body |
パラメータが格納された JSON 配列。 |
application/json
この API は、KPI のすべての要約を取得します。
GET
/api/analytics/v1/summary
N
なし。
application/json
この API は、特定の KPI 要約一式または利用可能な KPI 要約リストを取得します。
GET
/api/analytics/v1/summary/:summaryItem
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
summaryItem |
Y |
— |
文字列 |
pathReplace |
対象とする KPI 要約のカンマ区切りリスト、または利用可能なメトリックのリストを表示する場合は「availableMetrics」。 |
application/json
パラメータを格納する JSON 配列が、唯一のパラメータ(本体)です。以下に、JSON 配列に格納されるパラメータについて説明します。
POST
/api/analytics/v1/connectedDetected
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
body |
Y |
— |
JSON 配列 |
body |
パラメータが格納された JSON 配列。 |
application/json
この API は、特定の要素について、指定されたタイムフレーム内のデバイス数のルールと一致した通知イベントのリストを取得します。
GET
/api/analytics/v1/notifications/deviceCount/:elementId/:timeFrame
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
elementId |
N |
— |
文字列 |
pathReplace |
対象とする多頭的階層要素の数値 ID。 |
timeFrame |
N |
— |
文字列 |
pathReplace |
タイムフレームを定義する時間(分単位)。 たとえば、timeFrame=60 と指定すると、過去 1 時間の通知アラートが取得されます。 |
application/json
特定の要素について、デバイス数のルールと一致した通知イベントのリストを取得します。
GET
/api/analytics/v1/notifications/deviceCount/:elementId
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
elementId |
N |
— |
文字列 |
pathReplace |
対象とする多頭的階層要素の数値 ID。 |
application/json
デバイス数のルールと一致した通知イベントのリストを取得します。
GET
/api/analytics/v1/notifications/deviceCount
N
なし。
application/json
パラメータを格納する JSON 配列が、唯一のパラメータ(本体)です。以下に、JSON 配列に格納されるパラメータについて説明します。
POST
/api/analytics/v1/queue
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
body |
Y |
— |
JSON 配列 |
body |
パラメータが格納された JSON 配列。 |
application/json
パラメータを格納する JSON 配列が、唯一のパラメータ(本体)です。以下に、JSON 配列に格納されるパラメータについて説明します。
POST
/api/analytics/v1/overview
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
body |
Y |
— |
JSON 配列 |
body |
パラメータが格納された JSON 配列。 |
application/json
パラメータを格納する JSON 配列が、唯一のパラメータです。以下に、JSON 配列に格納されるパラメータについて説明します。
POST
/api/analytics/v1/deviceDwell
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
body |
Y |
— |
JSON 配列 |
body |
パラメータが格納された JSON 配列。 |
application/json
パラメータを格納する JSON 配列が、唯一のパラメータ(本体)です。以下に、JSON 配列に格納されるパラメータについて説明します。
POST
/api/analytics/v1/deviceCount
N
名前 |
必須 |
デフォルト |
タイプ |
場所 |
説明 |
---|---|---|---|---|---|
body |
Y |
— |
JSON 配列 |
body |
パラメータが格納された JSON 配列。 |
application/json