基本機能利用ガイド 最終更新日 Fri, Sep 2, 2016

Edit on GitHub

概要

Growthbeat ではサーバー API を用意しております。Growthbeat プラットフォームに蓄積されたデータを管理画面外からも取得することが可能となっております。

APIを使用する前に

API を利用するには Growthbeat への会員登録が必要となります。API を使用するにはアカウントに紐付いている API キーの使用が必須となります。API キーの取得方法は こちら を参照してください。

リクエスト

APIとの全ての通信にはHTTPSプロトコルを利用します。

利用サービス アクセス先ホスト
Growthbeat api.growthbeat.com
Growth Push api.growthpush.com

利用制限

API を使用すると API ごとにリクエスト数が加算されます。ご契約のリクエスト数、現在のリクエスト数に応じて使用する API を考慮してください。月のAPIの上限を超えますと APIに てデータが取得できなくなりますのでご了承ください。現在の使用リクエスト数は こちら を参照してください。

データ形式

APIとのデータの送受信にはJSONを利用します。JSONをリクエストボディに含める場合、リクエストのContent-Typeヘッダに application/json を指定し、リクエストヘッダーは application/x-www-form-urlencoded で送信してください。 GETリクエストにバラメータを含める場合にはURIクエリを利用します。

正常なレスポンスの場合は、リファレンスにあるAPIごとのJSON形式のレスポンスが返ります。エラーレスポンス時には、エラーコード、エラーメッセージのみのJSON形式のレスポンスが返ります。

正常なレスポンス例

curl -X GET \
    -H 'Accept: application/json' \
    -G \
    --data "applicationId=GROWTHBEAT_APPLICATION_ID" \
    --data "credentialId=GROWTHBEAT_CREDENTIAL_ID" \
    https://api.growthpush.com/4/clients/GROWTHBEAT_CLIENT_ID | jq .

{
  "id": "GROWTHBEAT_CLIENT_ID",
  "applicationId": "GROWTHBEAT_APPLICATION_ID",
  "token": "DEVICE_TOKEN",
  "status": "STATUS",
  "os": "OS",
  "environment": "ENVIRONMENT",
  "updated": "2015-02-03 12:34:56",
  "created": "2015-02-03 12:34:56"
}

エラーレスポンス例

curl -X GET \
    -H 'Accept: application/json' \
    -G \
    --data "applicationId=GROWTHBEAT_APPLICATION_ID" \
    --data "credentialId=GROWTHBEAT_CREDENTIAL_ID" \
    https://api.growthpush.com/4/clients/GROWTHBEAT_CLIENT_ID | jq .

{
    "status": 400,
    "message": "Invaid credential.",
    "code": 1001
}

APIドキュメント一覧

活用例