APIレスポンスが期待したデータを返さない場合、リクエストがサブスクリプションのデフォルトアプリケーションに自動的に切り替わっている可能性があります。これは通常、サブスクリプションに複数のアプリケーション(ウェブまたはモバイル)がある場合に発生します。
デフォルトでは、Pendo APIリクエストはサブスクリプションのデフォルトアプリケーションからのみデータを返します。これは常にサブスクリプションがプロビジョニングされたときに作成された元のウェブアプリケーションです。
- サブスクリプションにウェブアプリが1つだけある場合、APIリクエストは常にそのアプリからデータを返します。
- 複数のアプリがある場合、またはモバイルアプリのみの場合、リクエストを明示的に変更しない限り、デフォルトの動作には他のアプリからのデータは含まれません。
以下の例はすべてPendo USインスタンス(https://app.pendo.io)を使用しています。サブスクリプションが他の地域でホストされている場合は、適切なベースURLをご利用ください。
https://app.eu.pendo.iohttps://us1.app.pendo.iohttps://app.jpn.pendo.iohttps://app.au.pendo.io
すべてのアプリケーションからデータを要求する
サブスクリプション内のすべてのアプリからデータを含めるには、リクエストするデータの種類に応じてリクエストを変更してください。
ページ、フィーチャー、ガイド
URLの末尾に?expand=*を追加します。
https://app.pendo.io/api/v1/page?expand=*
https://app.pendo.io/api/v1/feature?expand=*
https://app.pendo.io/api/v1/guide?expand=*集計(イベント)データの場合
"appId": "expandAppIds(\"*\")" をリクエスト本文のイベントソースに追加します。次の例は、pageEventsソースの場合です。
{
"response": {
"mimeType": "application/json"
},
"request": {
"pipeline": [
{
"source": {
"pageEvents": {
"appId": "expandAppIds(\"*\")"
},
"timeSeries": {
"period": "dayRange",
"first": "now()",
"count": -1
}
}
}
]
}
}特定のアプリケーションからデータを要求する
特定のアプリをターゲットにするには、そのapplicationIdを知る必要があります。以下の例では、1111111111111111はapplicationIdのプレースホルダーです。
ページ、フィーチャー、ガイド
URLの末尾に?appId= {{applicationId}}を追加します。
https://app.pendo.io/api/v1/page?appId=1111111111111111
https://app.pendo.io/api/v1/feature?appId=1111111111111111
https://app.pendo.io/api/v1/guide?appId=1111111111111111集計(イベント)データの場合
リクエスト本文のイベントソースに"appId": {{applicationId}}を追加してください。次の例は、pageEventsソースの場合です。
{
"response": {
"mimeType": "application/json"
},
"request": {
"pipeline": [
{
"source": {
"pageEvents": {
"appId": 1111111111111111
},
"timeSeries": {
"period": "dayRange",
"first": "now()",
"count": -1
}
}
}
]
}
}アプリケーションIDの確認方法
applicationIdを見つけるには:
- Pendoで、[設定(Settings)]>[サブスクリプション設定(Subscription settings)]に移動します。
- [アプリケーション]タブから、目的のアプリを選択します。
- ブラウザのURLを確認してください:
https://app.pendo.io/s/{{subscriptionId}}/admin/app/{{applicationId}}?tab=details-
applicationIdは末尾にある長い数値の文字列です。 - デフォルトのアプリケーションは常に
-323232を使用します。
-
追加ドキュメント
Pendo APIの詳細については公式開発者ドキュメントをご覧ください。