【PowerShell】curlコマンドのパラメータ指定について

Question

お世話になっております。

APIチュートリアルに記載されているcurlコマンド(MAC)を
PowerShellにて実施できないか調査中です。
https://api-docs.sprinklr.com/#intro

以下のコマンドは一時拝借させていただいているMACにて実行し、結果が取得出来る事を確認済です。

curl --location --request POST "https://api2.sprinklr.com/api/v1/reports/query" \
  --header "key: API_KEY" \
  --header "Authorization: Bearer API_TOKEN" \
  --header "Content-Type: application/json" \
  --data "{
  \"startTime\":1545000000000,
  \"endTime\":1555600000000,
  \"timeZone\":\"UTC\",
  \"page\":0,
  \"pageSize\":20,
  \"reportingEngine\":\"PAID\",
  \"report\":\"DAILY_AD_STAT\",
  \"groupBys\":[
    {
      \"heading\":\"adChannel\",
      \"dimensionName\":\"adChannel\",
      \"groupType\":\"FIELD\",
      \"details\":{}
    },
    {
      \"heading\":\"DAY_OF_WEEK\",
      \"dimensionName\":\"DAY_OF_WEEK\",
      \"groupType\":\"FIELD\",
      \"details\":{}
    }
  ],
  \"projections\":[
    {
      \"heading\":\"impressions\",
      \"measurementName\":\"impressions\",
      \"aggregateFunction\":\"SUM\"
    },
    {
      \"heading\":\"spent\",
      \"measurementName\":\"spent\",
      \"aggregateFunction\":\"SUM\"
    },
    {
      \"heading\":\"Post_Comment\",
      \"measurementName\":\"actionsReportable.actionTypeValueMap.comment\",
      \"aggregateFunction\":\"SUM\"
    },
    {
      \"heading\":\"Post_Like\",
      \"measurementName\":\"actionsReportable.actionTypeValueMap.post_like\",
      \"aggregateFunction\":\"SUM\"
    },
    {
      \"heading\":\"post_engagement\",
      \"measurementName\":\"post_engagement\",
      \"aggregateFunction\":\"SUM\"
    }
  ]
}
"

拝借したPCを返却し、WindowsOSのみでの運用を考えておりますので、以下PowerShellのcurlコマンドを作成しました。

$l_ADHash = @{'key'='API_KEY'; 'Authorization'='Bearer API_TOKEN'; 'Content-Type'='application/json';}
$l_ADReportProjections = @(
	@{
		"heading"           ="impressions";
		"measurementName"   ="impressions";
		"aggregateFunction" ="SUM";
    },
	@{
		"heading"           ="spent";
		"measurementName"   ="spent";
		"aggregateFunction" ="SUM";
    },
    @{
		"heading"           ="Post_Comment";
		"measurementName"   ="actionsReportable.actionTypeValueMap.comment";
		"aggregateFunction" ="SUM";
    },
    @{
		"heading"           ="Post_Like";
		"measurementName"   ="actionsReportable.actionTypeValueMap.post_like";
		"aggregateFunction" ="SUM";
    },
    @{
		"heading"           ="post_engagement";
		"measurementName"   ="post_engagement";
		"aggregateFunction" ="SUM";
	}
)
$l_ADReportGroupBys = @(
    @{
        'heading'       ='adChannel';
        'dimensionName' ='adChannel';
        'groupType'     ='FIELD';
    },
    @{
        'heading'       ='DAY_OF_WEEK';
        'dimensionName' ='DAY_OF_WEEK';
        'groupType'     ='FIELD';
    }
)
$l_ADReportBody = @{
	'reportingEngine' = 'PAID';
    'report'          = 'DAILY_AD_STAT';  
    'startTime'       = 1545000000000;
    'endTime'         = 1555600000000;
    'page'            = 0;
    'pageSize'        = 20;
    'timeZone'        = 'UTC';
    'projections'     = $l_ADReportProjections;
    'groupBys'        = $l_ADReportGroupBys;
}
curl -Method Post "https://api2.sprinklr.com/api/v1/reports/query" -Headers $l_ADHash -Body $l_ADReportBody
###以下エラー
curl : Developer Inactive
発生場所 行:1 文字:1
+ curl -Method Post "https://api2.sprinklr.com/api/v1/reports/query" -H ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (System.Net.HttpWebRequest:HttpWebRequest) [Invoke-WebRequest]、WebException
    + FullyQualifiedErrorId : WebCmdletWebResponseException,Microsoft.PowerShell.Commands.InvokeWebRequestCommand
###

必要なデータは記載しきれたはずなのですが、、

curl : Developer Inactive
こちらはどの様なエラーなのでしょうか、、、
内側に
https://www.weblio.jp/content/Invalid+Operation+Exception
InvalidOperationException クラス
オブジェクトの現在の状態に対して無効なメソッド呼び出しが行われた場合にスローされる例外。
が存在している以上書き方の問題なのかなと考察しております。

1行目、terminal 2行目 powershell

\"projections\":[~~~~~]
'projections' = @(~~~~~)

備考 powershell -Bodyの中身

Name                           Value
----                           -----
projections                    {System.Collections.Hashtable, System.Collections.Hashtable, System.Collections.Hashtable, System.Collections.Hashtable...}
groupBys                       {System.Collections.Hashtable, System.Collections.Hashtable}
timeZone                       UTC
report                         DAILY_AD_STAT
reportingEngine                PAID
page                           0
pageSize                       20
startTime                      1545000000000
endTime                        1555600000000

[]と()又は{}の括りが違うから、、、なのでしょうか。
丸投げな質問となりますが、ご助力お願いできればと思います。
何卒よろしくお願い致します。

追記:try{}catch{}の結果

$_.Exception.Message
リモート サーバーがエラーを返しました: (434)
$_.Exception.Response.StatusCode.Value__
434
$_.Exception.Response.StatusDescription

追記:解決
ご回答いただきました方法から、
bodyオプションの文字列をjson化し、比較しましたが違いは見られず。
curl実施時に
-Body $l_ADReportBody | ConvertTo-json　でjson化した文字列を渡す
又は

#json化
$l_ADReportBody | ConvertTo-Json | Out-File hoge.json
#jsonから取得
$l_BodyJson = Get-Content .\hoge.json -Encoding UTF8

でjson化したファイル文字そのものを変数に詰めてパラメータ指定する事で解決しました。
ご回答ありがとうございました。また機会がありましたら是非よろしくお願い致します。

Answer 1

この API は、使ったことがないのですが...

ざっと眺めて比較してみた感じでは、PowerShell の方には、 groupBys に details キーがありませんね。

APIのドキュメントは、ログインユーザーしか参照できないようなので、必須／省略可能等が不明なのですが、必須キーワードであれば、省略するとエラーになると思います。

まずは、作成したオブジェクトを JSON としてファイルに書き出してみて、APIが要求する正しいフォーマットになっているか確認してみてください。

そして、作成したファイルを使用して、

curl -v -H "Content-type: application/json" -H "key: API_KEY" -H "Authorization: Bearer API_TOKEN"  -X POST -d @json-data-file.json  https://api2.sprinklr.com/api/v1/reports/query

のように curl コマンドを実行したら　どうなるでしょうか？

また、 macOS で実行して値が取得できたコマンドから --data 部分の JSON データを例えば mac-json-data.json の名前でファイルに保存して、 -d @mac-json-data.json と指定して、 同様に上記 curl コマンドで実行するとどうなりますか？

macOSで実行したデータでうまく行った場合は、PowerShell から書き出した JSON ファイルと中身を比較して異なっている部分を特定して修正してください。

Comments

[reraNine]

ご回答ありがとうございます。
対応内容はここに記載すると長くなる為、質問文を編集し、追記させていただきます。
jsonファイルの活用法は発想に全くありませんでした。こういった使い道もあるのですね！

Answer 2

まずはtry{}catch{}できちんとエラーハンドリングしてみましょう。

try {
    curl -Method Post "https://api2.sprinklr.com/api/v1/reports/query" -Headers $l_ADHash -Body $l_ADReportBody
} catch {
    # HTTPステータスコード
      $_.Exception.Message
      $_.Exception.Response.StatusCode.Value__
      $_.Exception.Response.StatusDescription
}

Comments

[reraNine]

ご回答ありがとうございます。
catchの結果を質問文に追記させていただきました。434...?
https://api-docs.sprinklr.com/#intro
上記リンク最初に記載されているError Code一覧に該当の番号が無い事から、
向こう側の予期せぬこちら側の責任下が原因である、、という事でしょうか。