Custom API Action

Mixpanel APIに対してカスタムの認証済みHTTP呼び出しを行います。

Mixpanel開発者ドキュメントを参照してください。

オプション

カスタムAPI呼び出しでサポートされているHTTPリクエストメソッド、つまりHTTP動詞を以下に示します(「HTTPリクエストメソッド」を参照)。

フィールド 定義 タイプ 必須
Request Type(リクエストタイプ)

GET:パラメーターに基づいてWebサーバーからデータを取得します。このメソッドは指定されたリソースの表現を要求します。リクエストが成功した場合、要求したコンテンツとともに200(OK)レスポンスメッセージを受信します。

POST:パラメーターに基づいてWebサーバーにデータを送信します(たとえば、ファイルのアップロードなど)。複数のPOSTリクエストは1つのPOSTと異なる結果になる場合があるため、意図せずに複数のPOSTリクエストを送信することについて注意が必要です。リクエストが成功した場合、200(OK)レスポンスメッセージを受信します。

PUT:パラメーターに基づいてWebサーバーの特定の場所に格納されるデータを送信します(たとえば、ファイルのアップロードなど)。PUTおよびPOSTリクエストの違いはPUTが冪等であるということです。つまり、リクエストが成功なら、同じPUTリクエストを何回実行しても、1回実行したときと同じ結果になります。リクエストが成功した場合、200(OK)201(Created)、または204(No Content)レスポンスメッセージを受信します。

PATCH:パラメーターに基づいてWebサーバー上のリソースに部分的な変更を適用します。PATCHは冪等ではありません。つまり、複数のPATCHリクエストによって意図しない結果が生じる可能性があります。PATCHが成功した場合、200(OK)または204(No Content)レスポンスメッセージが返されます。

DELETE:パラメーターに基づいてWebサーバーから特定のリソースを削除します(リソースが存在する場合)。DELETEが成功した場合、200(OK)レスポンスメッセージを受信します。

ドロップダウン

TRUE

Select API(APIの選択)

HTTPリクエスト用にMixpanel APIを指定します。

オプションは次のとおりです。

  • Ingestion API

  • Query API

  • Lexicon Schemas API

MixpanelコネクターのCustom API Actionカードを認証するには、次に示すいくつかの資格情報が必要です。

  • プロジェクト:トークン

  • プロジェクト:APIシークレット

  • サービスアカウント(ユーザー名とシークレット)

詳細については、「認可」を参照してください。

入力

フィールド 定義 タイプ 必須
Relative URL(相対URL)

呼び出すWebサーバーのURLアドレス。/{insert_remaining_URL}のように相対URLを指定します。「?」を使用して相対URL内にクエリパラメーターを指定したり、クエリ入力内のオブジェクトキーペアとしてクエリパラメーターを指定したりすることができます。

例:https://mixpanel.com/api/2.0/jql the relative URL is: /2.0/jql

Ingestion API(標準)の例:https://api.mixpanel.com/engage#profile-set the relative URL is: /engage#profile-set

Ingestion API(EU)の例:https://api.mixpanel.com/engage#profile-set the relative URL is: /engage#profile-set

Query API(標準)の例:https://api.mixpanel.com/engage#profile-set the relative URL is: /engage#profile-set

Query API(EU)の例:https://api.mixpanel.com/engage#profile-set the relative URL is: /engage#profile-set

Lexicon Schemas API(標準)の例:https://mixpanel.com/api/app/projects/{Project ID}/schemas the relative URL is: /{Project ID}/schemas

Lexicon Schemas API(EU)の例:https://mixpanel.com/api/app/projects/{Project ID}/schemas the relative URL is: /{Project ID}/schemas

Raw Data Export API(標準)の例:https://data.mixpanel.com/api/2.0/export{{ / input.Request.Relative URL }}

Raw Data Export API(EU)の例:https://data-eu.mixpanel.com/api/2.0/export{{ / input.Request.Relative URL }}

Data Pipelines API(標準)の例:https://data.mixpanel.com/api/2.0/nessie{{ / input.Request.Relative URL }}

Data Pipelines API(EU)の例:https://data-eu.mixpanel.com/api/2.0/nessie{{ / input.Request.Relative URL }}

Connectors API(標準)の例:https://data.mixpanel.com/api/2.0/export{{ / input.Request.Relative URL }}

Connectors API(EU)の例:https://data-eu.mixpanel.com/api/2.0/export{{ / input.Request.Relative URL }}

テキスト

TRUE

Query(クエリ) オブジェクト形式(キーと値のペア) で含める必要がある追加のクエリパラメーターを指定します。

オブジェクト

FALSE

Headers(ヘッダー) 認可またはコンテンツタイプ(これらはすでにこのコネクタで処理されている) に加えて必要な任意のヘッダーを指定します。

オブジェクト

FALSE

Body(本文) リクエストボディーをJSON形式で指定します。POSTPUTPATCHリクエストでのみ使用できます。

オブジェクト

FALSE

出力

フィールド 定義 タイプ

レスポンス

Status Code(ステータスコード)

操作の結果。コネクターは、カードによって実行されたアクションが成功したか失敗したかを示す、HTTPステータスコードを返します。例:

  • 201 Createdステータスコードは、アクションが成功し、新しいリソースが作成されたことを示します。
  • 403 Forbiddenエラーは、必要な権限が不足していたためにHTTPリクエストが処理されなかったことを示します。

発生する可能性があるステータスコードの完全なリストについては、「HTTPステータスコード」を参照してください。

数値

Headers(ヘッダー)

出力ボディーとは関係のない、ステータスコードの詳細なコンテキスト。レスポンスヘッダーは、選択したHTTPリクエストオプションによって決定します。すべてのヘッダーがレスポンスヘッダーというわけではありません。これは、{"Content-type":"application/json"}のようになります。

オブジェクト

Body(本文)

選択したHTTPリクエストから返されたデータ。

たとえば、GETリクエストからのデータ。

オブジェクト

関連項目

Mixpanelコネクター

Workflows要素

Mixpanel APIリファレンス