1. ホーム
  2. ユーザーガイド
  3. RESTfulAPIドキュメント
  4. 計数データAPI[ベータ版]
検索中...

計数データAPI[ベータ版]

説明 カウントデータのタイプを提供してこのエンドポイントを呼び出し、JSON文字列でペイロードオブジェクトをクエリして、JSON形式のカウントデータを取得します。
エンドポイント

{CubeHostAddress} / API / v1 / load

{CubeHostAddress}: https://cube.footfallcam.com (オンプレミス ソリューションを使用している場合は、ホスト アドレスについて FootfallCam サポートにお問い合わせください)
方法 POST
ヘッダ
  1. 承認：トークン値はから返されます API'GenerateAccessToken ' ユーザー名とパスワードを提供する
本文-JSONの例 {
    "クエリ"：{
        "対策"： [
            "ThisCubeName.FC01_SUM"、
            "ThisCubeName.FC01_AVG"、
            "ThisCubeName.FC02_SUM"、
            "ThisCubeName.FC02_AVG"
        ],
        "timeDimensions"：[
            {
                "ディメンション"： "ThisCubeName.Time"、
                "dateRange"：[
                    "2021-10-01T10:00:00.000",
                    「2021-10-31」
                ],
                「粒度」：「時間」
            }
        ],
        "注文"： [
            [
                "ThisCubeName.FC01_SUM"、
                「説明」
            ]
        ],
        「フィルター」：[
            {
                "メンバー"： "ThisCubeName.CompanyId"、
                「演算子」：「等しい」、
                "値"：[
                    "1001"
                ]
            },
            {
                "メンバー"： "ThisCubeName.BranchId"、
                「演算子」：「等しい」、
                "値"：[
                    「2001」、
                    "2001"
                ]
            },
            {
                "メンバー"： "ThisCubeName.BranchName"、
                「演算子」：「等しい」、
                "値"：[
                    「BranchName1」、
                    「BranchName2」
                ]
            },
            {
                "メンバー"： "ThisCubeName.AreaId"、
                「演算子」：「等しい」、
                "値"：[
                    「3001」、
                    「3002」、
                    "3003"
                ]
            }
        ],
        「寸法」：[
            "ThisCubeName.CompanyId"、
            "ThisCubeName.CompanyName"、
            "ThisCubeName.BranchId"、
            "ThisCubeName.BranchName"、
            "ThisCubeName.AreaId"、
            "ThisCubeName.AreaName"
        ],
        「制限」：50000
    }
}
本体の説明

キューブ名はペイロードに記載する必要があり、その使用可能なフィールドは選択したキューブによって異なります。 ご参照ください キューブのリスト キューブの詳細について

  1. クエリ（オブジェクト）：クエリデータのペイロードを定義します
  2. メジャー（文字列のリスト）：メトリックコードのリストと集計のタイプを定義します。
  3. timeDimensions（オブジェクトのリスト）：時間関連のパラメーターを定義するオブジェクトが含まれています
    1. ディメンション（文字列）：時間関連のパラメータを適用するためのディメンションを指定します
    2. dateRange（文字列のリスト）：データクエリの開始日時と終了日時を指定します。 例：「2021-10-01T10：00：00.000」、「2021-10-31」
    3. 粒度（文字列）：データの時間粒度を定義します。 例：分、時、日、週、月、年
  4. order（文字列リストのリスト）：データの順序を指定します。 各マイナーリストには、順序付けを適用するためのフィールド名とそれぞれの種類の順序付けが含まれています。 例：["ThisCubeName.FC01_SUM"、 "desc"]
  5. フィルタ（オブジェクトのリスト）：クエリデータのフィルタリングを定義します。
    1. member（string）：フィルターを適用するための次元を指定します。
    2. 演算子（文字列）：フィルターのタイプを定義します。 例：equals、notEquals、contains、notContains
    3. 値（文字列のリスト）：データをフィルタリングするための値を指定します。
  6. ディメンション（文字列のリスト）：SQLクエリの「Select」ステートメントと同様に、結果データに表示するディメンションを指定します。
  7. limit（int、optional）：返されるデータの最大レコード数を指定します。 デフォルト値は10000（ペイロードで指定されていない場合）、最大値は50000です。
応答1-JSONの例 {
    「エラー」：「待機を続行」、
    「ステージ」：{
        "ステージ"： "クエリの実行"、
        「timeElapsed」：5003
    }
}
応答1説明 「ContinueWait」応答は、バックエンドがクエリを実行して結果を返すまでに時間がかかる可能性があることを示しています。 API呼び出しが失敗したためではなく、クエリはバックエンドで実行されています。 後で再試行すると、バックエンドがクエリの実行を終了すると、APIは結果を返します。
応答2-JSONの例 {
    "クエリ"：{}、
    "データ"： [
{
            "cube3.CompanyId"： "18330"、
            "cube3.CompanyName"： "DemoCompany"、
            "cube3.BranchId"： "23097"、
            "cube3.BranchName"： "UKSite01"、
            "cube3.AreaId"： "-1"、
            "cube3.AreaName"： ヌル,
            "cube3.Time.hour": "2022-01-15T11:00:00.000",
            "cube3.Time": "2022-01-15T11:00:00.000",
            "cube3.FC01_SUM"：200、
            "cube3.FC01_MAX"：180、
            "cube3.FC01_AVG"：100、
            "cube3.FC01_MIN"：20、
            "cube3.FC02_SUM"：188、
            "cube3.FC02_MAX"：171、
            "cube3.FC02_AVG"：94、
            "cube3.FC02_MIN"：17
        },
        {
            "cube3.CompanyId"： "18330"、
            "cube3.CompanyName"： "DemoCompany"、
            "cube3.BranchId"： "23097"、
            "cube3.BranchName"： "UKSite01"、
            "cube3.AreaId"： "-1"、
            "cube3.AreaName"： ヌル,
            "cube3.Time.hour": "2022-01-07T15:00:00.000",
            "cube3.Time": "2022-01-07T15:00:00.000",
            "cube3.FC01_SUM"：175、
            "cube3.FC01_MAX"：100、
            "cube3.FC01_AVG"：87.5、
            "cube3.FC01_MIN"：75、
            "cube3.FC02_SUM"：174、
            "cube3.FC02_MAX"：95、
            "cube3.FC02_AVG"：87、
            "cube3.FC02_MIN"：79
        },
        {
            "cube3.CompanyId"： "18330"、
            "cube3.CompanyName"： "DemoCompany"、
            "cube3.BranchId"： "23097"、
            "cube3.BranchName"： "UKSite01"、
            "cube3.AreaId"： "-1"、
            "cube3.AreaName"： ヌル,
            "cube3.Time.hour": "2022-01-15T13:00:00.000",
            "cube3.Time": "2022-01-15T13:00:00.000",
            "cube3.FC01_SUM"：171、
            "cube3.FC01_MAX"：151、
            "cube3.FC01_AVG"：85.5、
            "cube3.FC01_MIN"：20、
            "cube3.FC02_SUM"：166、
            "cube3.FC02_MAX"：146、
            "cube3.FC02_AVG"：83、
            "cube3.FC02_MIN"：20
        }
],
    "lastRefreshTime": "2022-01-19T07:35:41.259Z",
    "refreshKeyValues"：[
        [
            {
                "refresh_key"： "13688147"
            }
        ]
    ],
    "usedPreAggregations"：{}、
    "transformedQuery"：{}、
    "requestId": "dda53bef-4d52-4377-aee8-74d2976cafc6-span-1",
    「注釈」：{}、
    "dataSource"： "デフォルト"、
    "dbType"： "prestodb"、
    "extDbType"： "cubestore"、
    「外部」：false、
    "slowQuery"：false
}
応答2説明 計数データの結果は、オブジェクトのリストとして「データ」セクションに表示されます。その他の追加情報は、将来削除される可能性があります。
2月に更新22、2023