Growth Push API v3

Deprecation Notice

NotificationAPI 以外のAPIは 廃止予定 です。APIをご利用の場合は、最新版 Growth Push API v4 をご利用ください.

Notifications ¶

Notification Object

Name	Type	Note
id	number	Notification ID
applicationId	number	Growth Push アプリケーションID
status	enum	送信状態 ( waiting/success/failure )
created	string	作成日時 ( YYYY-MM-DD HH:mm:ss )
attachNotificationId	boolean	指定するとペイロードに “growthpush”:{“notificationId”:xxxxx} という形式で、通知IDが含まれます。
duration	number	配信時刻からこの時間以上の時間が経過したpushは配信されずに破棄されます。ミリ秒で指定してください。
trial	array[Trial]
segment	Segment

Trial Object

Name	Type	Note
id	number	トライアルID
notifiationId	number	Notification ID
automationId	number	自動配信ID
text	string	配信文言
sound	boolean	通知音
badge	boolean	通知バッジ
extra	boolean	ペイロードに任意のパラメータを JSON形式で指定します。ex. {“url”:"https://growthpush.com"}
scheduled	string	配信予定時刻 ( YYYY-MM-DD HH:mm:ss )
status	enum	送信状態 ( standby/creating/waiting/pending/sending/completed )

Get Notifications ¶

Get Notifications
GET`/notifications{?applicationId}{&credentialId}{&page}{&limit}`

配信一覧所得

Example URI

GET https://api.growthpush.com/3/notifications?applicationId=&credentialId=&page=&limit=

URI Parameters

HideShow

applicationId: string (required)
Growthbeat アプリケーションID
credentialId: string (required)
Growthbeat クレデンシャルID
page: number (optional) Default: 1
ページ数
limit: number (optional) Default: 100
リミット

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "id": 0,
    "applicationId": 0,
    "segmentId": 0,
    "tagId": 0,
    "automationId": 0,
    "status": "waiting",
    "created": "2015-02-03 12:34:56",
    "trial": [
      {
        "id": 0,
        "notificationId": 0,
        "automationTrialId": 0,
        "text": "TEXT",
        "sound": true,
        "badge": true,
        "extra": "EXTRA",
        "scheduled": "2015-02-03 12:34:56",
        "status": "standby"
      }
    ],
    "segment": {
      "id": 0,
      "name": "NAME",
      "query": "QUERY",
      "size": 0,
      "invisible": true,
      "modified": "2015-02-03 12:34:56",
      "created": "2015-02-03 12:34:56"
    }
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Create New Notification ¶

Create New Notification
POST`/notifications`

新規配信作成

配信端末が100件に満たない場合は、配信一覧画面に表示されません。予めご了承下さい。

Example URI

POST https://api.growthpush.com/3/notifications

Request

HideShow

Headers

Content-Type: application/x-www-form-urlencoded

Body

{
  "applicationId": "GROWTHBEAT_APPLICATION_ID",
  "credentialId": "GROWTHBEAT_CREDENTIAL_ID",
  "query": "{}",
  "text": "text",
  "sound": true,
  "badge": true,
  "extra": "{}",
  "attachNotificationId": true,
  "duration": 1
}

Schema

{
  "type": "object",
  "properties": {
    "applicationId": {
      "type": "string",
      "description": "Growthbeat アプリケーションID"
    },
    "credentialId": {
      "type": "string",
      "description": "Growthbeat クレデンシャルID"
    },
    "query": {
      "type": "string",
      "description": "セグメントクエリ"
    },
    "text": {
      "type": "string",
      "description": "テキスト"
    },
    "sound": {
      "type": "boolean",
      "description": "通知音"
    },
    "badge": {
      "type": "boolean",
      "description": "通知バッジ"
    },
    "extra": {
      "type": "string",
      "description": "任意のパラメータを追加"
    },
    "attachNotificationId": {
      "type": "boolean",
      "description": "通知IDの追加"
    },
    "duration": {
      "type": "number",
      "description": "ミリ秒で指定"
    }
  },
  "required": [
    "applicationId",
    "credentialId"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "jobId": "JOB_ID"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string"
    }
  }
}

Clients ¶

Clients Object

Name	Type	Notes
growthbeatApplicationId	string	Grwothbeat アプリケーションID
growthbeatClientId	string	Growthbeat クライアントID
id	number	Growth Push クライアントID
token	string	デバイストークン
os	enum	OS ( ios/android )
status	enum	プッシュ通知ステータス ( unknown/validating/active/inactive/invalid )
environment	enum	デバイス環境 ( development/production )
applicationId	number	Growth Push アプリケーションID
code	string	Growth Push Code
created	string	作成日 ( YYYY-MM-DD HH:mm:ss )

Get Client By Device Token ¶

Get Client By Device Token
GET`/clients{?applicationId}{&credentialId}{&token}`

クライアント取得

Deprecation Notice

このAPIは 廃止予定 です。

Example URI

GET https://api.growthpush.com/3/clients?applicationId=&credentialId=&token=

URI Parameters

HideShow

applicationId: string (required)
Growthbeat アプリケーションID
credentialId: string (required)
Growthbeat クレデンシャルID
token: string (required)
デバイストークン

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "id": 0,
  "code": "DEVICE_CODE",
  "token": "DEVICE_TOKEN",
  "growthbeatClientId": "GROWTHBEAT_CLIENT_ID",
  "growthbeatApplicationId": "GRWOTHBEAT_APPLICATION_ID",
  "os": "ios",
  "status": "unknown",
  "environment": "production",
  "applicationId": 0,
  "created": "2015-02-03 12:34:56"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "code": {
      "type": "string"
    },
    "token": {
      "type": "string"
    },
    "growthbeatClientId": {
      "type": "string"
    },
    "growthbeatApplicationId": {
      "type": "string"
    },
    "os": {
      "type": "string",
      "enum": [
        "ios",
        "android"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "unknown",
        "validating",
        "active",
        "inactive",
        "invalid"
      ]
    },
    "environment": {
      "type": "string",
      "enum": [
        "production",
        "development"
      ]
    },
    "applicationId": {
      "type": "number"
    },
    "created": {
      "type": "string"
    }
  }
}

Create New Client ¶

Create New Client
POST`/clients`

新規クライアント作成

Deprecation Notice

このAPIは 廃止予定 です。

Example URI

POST https://api.growthpush.com/3/clients

Request

HideShow

Headers

Content-Type: application/x-www-form-urlencoded

Body

{
  "clientId": "GROWTHBEAT_CLIENT_ID",
  "credentialId": "GROWTHBEAT_CREDENTIAL_ID",
  "token": "DEVICE_TOKEN",
  "os": "ios",
  "environment": "production"
}

Schema

{
  "type": "object",
  "properties": {
    "clientId": {
      "type": "string",
      "description": "Growthbeat クライアントID"
    },
    "credentialId": {
      "type": "string",
      "description": "Growthbeat クレデンシャルID"
    },
    "token": {
      "type": "string",
      "description": "デバイストークン"
    },
    "os": {
      "enum": [
        "ios",
        "android"
      ],
      "description": "OS"
    },
    "environment": {
      "enum": [
        "production",
        "development"
      ],
      "description": "デバイス環境"
    }
  },
  "required": [
    "clientId",
    "credentialId",
    "os",
    "environment"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "id": 0,
  "code": "DEVICE_CODE",
  "token": "DEVICE_TOKEN",
  "growthbeatClientId": "GROWTHBEAT_CLIENT_ID",
  "growthbeatApplicationId": "GRWOTHBEAT_APPLICATION_ID",
  "os": "ios",
  "status": "unknown",
  "environment": "production",
  "applicationId": 0,
  "created": "2015-02-03 12:34:56"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "code": {
      "type": "string"
    },
    "token": {
      "type": "string"
    },
    "growthbeatClientId": {
      "type": "string"
    },
    "growthbeatApplicationId": {
      "type": "string"
    },
    "os": {
      "type": "string",
      "enum": [
        "ios",
        "android"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "unknown",
        "validating",
        "active",
        "inactive",
        "invalid"
      ]
    },
    "environment": {
      "type": "string",
      "enum": [
        "production",
        "development"
      ]
    },
    "applicationId": {
      "type": "number"
    },
    "created": {
      "type": "string"
    }
  }
}

Update a Client ¶

Update a Client
PUT`/clients/{clientId}`

クライアント更新

Deprecation Notice

このAPIは 廃止予定 です。

Example URI

PUT https://api.growthpush.com/3/clients/clientId

URI Parameters

HideShow

clientId: string (required)
Growthbeat クライアントID

Request

HideShow

Headers

Content-Type: application/x-www-form-urlencoded

Body

{
  "credentialId": "GROWTHBEAT_CREDENTIAL_ID",
  "token": "DEVICE_TOKEN",
  "environment": "production"
}

Schema

{
  "type": "object",
  "properties": {
    "credentialId": {
      "type": "string",
      "description": "Growthbeat クレデンシャル"
    },
    "token": {
      "type": "string",
      "description": "デバイストークン"
    },
    "environment": {
      "enum": [
        "production",
        "development"
      ],
      "description": "デバイス環境"
    }
  },
  "required": [
    "credentialId"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "id": 0,
  "code": "DEVICE_CODE",
  "token": "DEVICE_TOKEN",
  "growthbeatClientId": "GROWTHBEAT_CLIENT_ID",
  "growthbeatApplicationId": "GRWOTHBEAT_APPLICATION_ID",
  "os": "ios",
  "status": "unknown",
  "environment": "production",
  "applicationId": 0,
  "created": "2015-02-03 12:34:56"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "code": {
      "type": "string"
    },
    "token": {
      "type": "string"
    },
    "growthbeatClientId": {
      "type": "string"
    },
    "growthbeatApplicationId": {
      "type": "string"
    },
    "os": {
      "type": "string",
      "enum": [
        "ios",
        "android"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "unknown",
        "validating",
        "active",
        "inactive",
        "invalid"
      ]
    },
    "environment": {
      "type": "string",
      "enum": [
        "production",
        "development"
      ]
    },
    "applicationId": {
      "type": "number"
    },
    "created": {
      "type": "string"
    }
  }
}

Events ¶

Event Object

Name	Type	Note
goalId	number	イベントID
timestamp	number	作成日時
clientId	number	Growth Push クライアントID
value	string	イベント値

Create New Event ¶

Create New Event
POST`/events`

新規イベント作成

Deprecation Notice

このAPIは 廃止予定 です。

Example URI

POST https://api.growthpush.com/3/events

Request

HideShow

Headers

Content-Type: application/x-www-form-urlencoded

Body

{
  "clientId": "GROWTHBEAT_CLIENT_ID",
  "credentialId": "GROWTHBEAT_CREDENTIAL_ID",
  "name": "NAME",
  "value": "VALUE"
}

Schema

{
  "type": "object",
  "properties": {
    "clientId": {
      "type": "string",
      "description": "Growthbeat クライアントID"
    },
    "credentialId": {
      "type": "string",
      "description": "Growthbeat クレデンシャルID"
    },
    "name": {
      "type": "string",
      "description": "イベント名"
    },
    "value": {
      "type": "string",
      "description": "イベント値"
    }
  },
  "required": [
    "clientId",
    "credentialId",
    "name"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "goalId": 0,
  "timestamp": 0,
  "clientId": 0,
  "value": "VALUE"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "goalId": {
      "type": "number"
    },
    "timestamp": {
      "type": "number"
    },
    "clientId": {
      "type": "number"
    },
    "value": {
      "type": "string"
    }
  }
}

Segments ¶

Segment Object

Name	Type	Note
id	number	セグメントID
name	string	セグメント名
query	string	JSON形式のセグメント。セグメントには、タグ・イベント・セグメントをかけ合わせて組み合わせることができます。
size	number	セグメント対象人数詳細はセグメントの概算人数とは？いつ更新されるのか？参照。
invisible	boolean	削除フラグ
modified	string	更新日時 ( YYYY-MM-DD HH:mm:ss )
created	string	作成日時 ( YYYY-MM-DD HH:mm:ss )

Segment Query

query パラメーターに指定する JSON形式のセグメント作成方法

タグセグメント

Parameter	Value	Note
type	tag	タグ指定は必ず `tag` と入力してください。
tagId	任意のタグID	管理画面から tagId を確認してください
operator	equal(=) / begin_witch(前方一致) / less_equal(>=) / less_than(<) / greater_qeual(>=) / greater_than(>) / exist(存在) / in(含む)	指定する value に合わせて変更してください
value	任意の値	抽出するタグの値

男性ユーザー

{"type":"tag","tagId":2,"operator":"equal","value":"male"}

指定のタグが紐づいているユーザー

{"type":"tag","tagId":3,"operator":"exist"}

指定のタグに xxxx,YYYY,ZZzzAA…… の value が紐づいているユーザー (valueの値は 10件以上 指定する必要がございます。)

{"type":"tag","tagId":4,"operator":"in","value":"xxxx,YYYY,ZZzzAA……"}

イベントセグメント

Parameter	Value	Note
type	event	イベント指定は必ず event と入力してください
goalId	任意のイベントID	管理画面から eventId(goalId) を確認してください
range	relative(相対時間) / absolute(絶対時間)	相対時間もしくは絶対時間を指定できます
begin	relative(現在時刻からの指定時間までのミリ秒) / absolute(YYYY-MM-DD HH:mm:ss)	期限の開始時間を設定します
end	relative(現在時刻からの指定時間までのミリ秒) / absolute(YYYY-MM-DD HH:mm:ss)	期限の終了時間を設定します
aggregation	count(発生回数) / summation(値の合計) / maximu(値の合計) / minimum(値の最小)	イベントの計算豊富お
operator	equal(=) / begin_witch(前方一致) / less_equal(>=) / less_than(<) / greater_qeual(>=)	指定する value に合わせて変更してください
value	任意の値	aggregation に対する指定値

72時間で1回以上起動しているユーザー

{"type":"event","goalId":1,"range":"relative","aggregation":"count","operator":"greater_equal","value":1.0,"begin":259200000,"end":0}

セグメント掛けあわせ

Parameter	Value	Note
type	and / or	and 演算子、 or 演算子で計算します
conditions	タグ・イベントの掛けあわせ	JSON形式

男性ユーザー、かつ72時間で1回以上起動しているユーザー

{"type":"and","conditions":[{"type":"tag","tagId":2,"operator":"equal","value":"male"},{"type":"event","goalId":1,"range":"relative","aggregation":"count","operator":"greater_equal","value":1.0,"begin":259200000,"end":0}]}

東京のユーザー、または神奈川のユーザー

{"type":"or","conditions":[{"type":"tag","tagId":4,"operator":"equal","value":"Tokyo"},{"type":"tag","tagId":4,"operator":"equal","value":"Kanagawa"}]}

ユーザーID複数して、24時間前の課金合計が5000以上のユーザー

{"type":"and","conditions":[{"type":"tag","tagId":25,"operator":"in","value":"111,23,90,150,72,65,55,1320"},{"type":"event","goalId":5,"range":"relative","aggregation":"summation","operator":"greater_equal","value":50000,"begin":3600000,"end":0}]}

否定セグメント

Parameter	Value	Note
type	not	論理否定
conditions	タグ・イベントの掛けあわせ	JSON形式

72時間で1回も起動していないユーザー

{"type":"not","condition":{"type":"event","goalId":1,"range":"relative","aggregation":"count","operator":"greater_equal","value":1.0,"begin":259200000,"end":0}}

既存セグメント

Parameter	Value	Note
type	segment	セグメント指定の場合は必ず segment と入力してください
segmentId	任意のセグメントID	既に作成済みのセグメントIDを指定してください

セグメントを指定かつ、OSがiOSのユーザー

{"type":"and","conditions":[{"type":"segment","segmentId":10},{"type":"tag","tagId":4,"operator":"begin_with","value":"iOS"}]}

Get Segments ¶

Get Segments
GET`/segments{?applicationId}{&credentialId}{&page}{&limit}`

セグメント一覧取得

Deprecation Notice

このAPIは 廃止予定 です。

Example URI

GET https://api.growthpush.com/3/segments?applicationId=&credentialId=&page=&limit=

URI Parameters

HideShow

applicationId: string (required)
Growthbeat アプリケーションID
credentialId: string (required)
Growthbeat クレデンシャルID
page: number (optional) Default: 1
ページ数
limit: number (optional) Default: 100
リミット

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "id": 0,
    "name": "NAME",
    "query": "QUERY",
    "size": 0,
    "invisible": true,
    "modified": "2015-02-03 12:34:56",
    "created": "2015-02-03 12:34:56"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Get Segment Size ¶

Get Segment Size
GET`/segments/size{?applicationId}{&credentialId}{&condition}`

セグメントサイズ取得

Deprecation Notice

このAPIは 廃止予定 です。

Example URI

GET https://api.growthpush.com/3/segments/size?applicationId=&credentialId=&condition=

URI Parameters

HideShow

applicationId: string (required)
Growthbeat アプリケーションID
credentialId: string (required)
Growthbeat クレデンシャルID
condition: string (required)
query（JSON形式 のセグメント）

Response 200

HideShow

Headers

Content-Type: application/json

Body

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "number"
}

Create New Segment ¶

Create New Segment
POST`/segments`

新規セグメント作成

Deprecation Notice

このAPIは 廃止予定 です。

Example URI

POST https://api.growthpush.com/3/segments

Request

HideShow

Headers

Content-Type: application/x-www-form-urlencoded

Body

{
  "applicationId": "GROWTHBEAT_APPLICATION_ID",
  "credentialId": "GROWTHBEAT_CREDENTIAL_ID",
  "name": "NAME",
  "query": "QUERY"
}

Schema

{
  "type": "object",
  "properties": {
    "applicationId": {
      "type": "string",
      "description": "Growthbeat アプリケーションID"
    },
    "credentialId": {
      "type": "string",
      "description": "Growthbeat クレデンシャルID"
    },
    "name": {
      "type": "string",
      "description": "セグメント名"
    },
    "query": {
      "type": "string",
      "description": "**JSON形式** のセグメント"
    }
  },
  "required": [
    "applicationId",
    "credentialId",
    "name",
    "query"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "id": 0,
  "name": "NAME",
  "query": "QUERY",
  "size": 0,
  "invisible": true,
  "modified": "2015-02-03 12:34:56",
  "created": "2015-02-03 12:34:56"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "query": {
      "type": "string"
    },
    "size": {
      "type": "number"
    },
    "invisible": {
      "type": "boolean"
    },
    "modified": {
      "type": "string"
    },
    "created": {
      "type": "string"
    }
  }
}

Update a Segment ¶

Update a Segment
PUT`/segments/{segmentId}`

セグメント更新

Deprecation Notice

このAPIは 廃止予定 です。

Example URI

PUT https://api.growthpush.com/3/segments/segmentId

URI Parameters

HideShow

segmentId: string (required)
セグメントID

Request

HideShow

Headers

Content-Type: application/x-www-form-urlencoded

Body

{
  "credentialId": "GROWTHBEAT_CREDENTIAL_ID",
  "name": "NAME",
  "query": "QUERY"
}

Schema

{
  "type": "object",
  "properties": {
    "credentialId": {
      "type": "string",
      "description": "Growthbeat クレデンシャルID"
    },
    "name": {
      "type": "string",
      "description": "セグメント名"
    },
    "query": {
      "type": "string",
      "description": "**JSON形式** のセグメント"
    }
  },
  "required": [
    "credentialId"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "id": 0,
  "name": "NAME",
  "query": "QUERY",
  "size": 0,
  "invisible": true,
  "modified": "2015-02-03 12:34:56",
  "created": "2015-02-03 12:34:56"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "query": {
      "type": "string"
    },
    "size": {
      "type": "number"
    },
    "invisible": {
      "type": "boolean"
    },
    "modified": {
      "type": "string"
    },
    "created": {
      "type": "string"
    }
  }
}

Tags ¶

Tag Object

Name	Type	Note
id	number	タグID
applicationId	number	Growth Push アプリケーションID
type	enum	タグタイプ ( custom/message )
name	string	タグ名
value	string	タグ値
invisible	boolean	削除フラグ
created	string	作成日 ( YYYY-MM-DD HH:mm:ss )

Get Tag ¶

Get Tag
GET`/tags{?applicationId}{&credentialId}{&name}`

タグ取得

Deprecation Notice

このAPIは 廃止予定 です。

Example URI

GET https://api.growthpush.com/3/tags?applicationId=&credentialId=&name=

URI Parameters

HideShow

applicationId: string (required)
Growthbeat アプリケーションID
credentialId: string (required)
Growthbeat クレデンシャルID
name: string (required)
タグ名

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "id": 0,
  "applicationId": 0,
  "type": "custom",
  "invisible": true,
  "created": "2015-02-03 12:34:56"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "applicationId": {
      "type": "number"
    },
    "type": {
      "type": "string",
      "enum": [
        "custom",
        "message"
      ]
    },
    "invisible": {
      "type": "boolean"
    },
    "created": {
      "type": "string"
    }
  }
}

Tag Clients ¶

タグに紐づくクライアントを抽出するAPIです

Tag Client Object

Name	Type	Note
tagId	number	タグID
clientId	number	Growth Push クライアントID
value	string	タグ値

Get Tag Clients By Tag Id ¶

Get Tag Clients By Tag Id
GET`/tags{?tagId}{&credentialId}{&exclusiveClientId}{&limit}{&order}`

タグクライアントリスト取得

Deprecation Notice

このAPIは 廃止予定 です。

Example URI

GET https://api.growthpush.com/3/tags?tagId=&credentialId=&exclusiveClientId=&limit=&order=

URI Parameters

HideShow

tagId

number (required)

タグID

credentialId

string (required)

Growthbeat クレデンシャルID

exclusiveClientId

number (optional)

Growth Push クライアントID

limit

number (optional) Default: 100

リミット

order

string (optional) Default: descoding

ソート

Choices: ascending descending

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "tagId": 0,
    "clientId": 0,
    "value": "VALUE"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Get Tag Clients By Client Id ¶

Get Tag Clients By Client Id
GET`/tags{?clientId}{&credentialId}{&type}{&exclusiveTagId}{&limit}{&order}`

タグクライアントの取得

Deprecation Notice

このAPIは 廃止予定 です。

Example URI

GET https://api.growthpush.com/3/tags?clientId=&credentialId=&type=&exclusiveTagId=&limit=&order=

URI Parameters

HideShow

clientId

string (required)

Growthbeat クライアントID

credentialId

string (required)

Growthbeat クレデンシャルID

type

string (optional)

タグタイプ

Choices: custom notification automation message

exclusiveTagId

number (optional)

タグID

limit

number (optional) Default: 100

リミット

order

string (optional) Default: descoding

ソート

Choices: ascending descending

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "tagId": 0,
    "clientId": 0,
    "value": "VALUE"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Create New Tags ¶

Create New Tags
POST`/tags`

タグクライアントの作成

Deprecation Notice

このAPIは 廃止予定 です。

Growthbeat クライアントID と、Growthbeat クレデンシャルID を使用します。
このAPIは、指定のデバイスにまとめてタグ付けをします。既にタグが登録されている場合は、そのvalueを更新します。
リクエスト数は指定したタグの件数分カウントされます。また、Notificationタグは更新する事はできません。
大量のタグを更新することを想定しているため 反映までに時間がかかる場合があります(数時間以上かかる場合があります) 。即時性が必要な場合は、1件ずつのタグ付けを利用してください。

Example URI

POST https://api.growthpush.com/3/tags

Request

HideShow

Headers

Content-Type: application/x-www-form-urlencoded

Body

{
  "{\"clientId\"": "\"GROWTHBEAT_CLIENT_ID\",\"credentialId\":\"GROWTHBEAT_CREDENTIAL_ID\",\"tagIdValues\":[{\"tagId\":1,\"value\":\"hoge\"},{\"tagId\":2,\"value\":\"fuga\"}]}"
}

Schema

{
  "type": "object",
  "properties": {
    "{\"clientId\"": {
      "type": "string",
      "description": "JSON"
    }
  },
  "required": [
    "{\"clientId\""
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "tagId": 0,
    "clientId": 0,
    "value": "VALUE"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Create New Tag By Client Id ¶

Create New Tag By Client Id
POST`/tags`

タグクライアントの作成

Deprecation Notice

このAPIは 廃止予定 です。

このAPIは、Growthbeat クレデンシャルID と、Growthbeat クライアントID を元にタグを紐付けます。

Example URI

POST https://api.growthpush.com/3/tags

Request

HideShow

Headers

Content-Type: application/x-www-form-urlencoded

Body

{
  "clientId": "GROWTHBEAT_CLIENT_ID",
  "credentialId": "GROWTHBEAT_CREDENTIAL_ID",
  "name": "NAME",
  "value": "VALUE"
}

Schema

{
  "type": "object",
  "properties": {
    "clientId": {
      "type": "string",
      "description": "Growthbeat クライアントID"
    },
    "credentialId": {
      "type": "string",
      "description": "Growthbeat クレデンシャルID"
    },
    "name": {
      "type": "string",
      "description": "タグ名"
    },
    "value": {
      "type": "string",
      "description": "タグ値"
    }
  },
  "required": [
    "clientId",
    "credentialId",
    "name"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "tagId": 0,
  "clientId": 0,
  "value": "VALUE"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "tagId": {
      "type": "number"
    },
    "clientId": {
      "type": "number"
    },
    "value": {
      "type": "string"
    }
  }
}

Create New Tag By Device Token ¶

Create New Tag By Device Token
POST`/tags`

タグクライアントの作成

Deprecation Notice

このAPIは 廃止予定 です。

このAPIは、Growthbeat クレデンシャルID と、デバイストークンを元にタグを紐付けます。

Example URI

POST https://api.growthpush.com/3/tags

Request

HideShow

Headers

Content-Type: application/x-www-form-urlencoded

Body

{
  "applicationId": "GROWTHBEAT_APPLICATION_ID",
  "credentialId": "GROWTHBEAT_CREDENTIAL_ID",
  "token": "DEVICE_TOKEN",
  "name": "NAME",
  "value": "VALUE"
}

Schema

{
  "type": "object",
  "properties": {
    "applicationId": {
      "type": "string",
      "description": "Growthbeat アプリケーションID"
    },
    "credentialId": {
      "type": "string",
      "description": "Growthbeat クレデンシャルID"
    },
    "token": {
      "type": "string",
      "description": "デバイストークン"
    },
    "name": {
      "type": "string",
      "description": "タグ名"
    },
    "value": {
      "type": "string",
      "description": "タグ値"
    }
  },
  "required": [
    "applicationId",
    "credentialId",
    "token",
    "name"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "tagId": 0,
  "clientId": 0,
  "value": "VALUE"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "tagId": {
      "type": "number"
    },
    "clientId": {
      "type": "number"
    },
    "value": {
      "type": "string"
    }
  }
}

Deprecation Notice ¶

Notifications ¶

Get Notifications ¶

Get NotificationsGET/notifications{?applicationId}{&credentialId}{&page}{&limit}

Example URI

Headers

Body

Schema

Create New Notification ¶

Create New NotificationPOST/notifications

Example URI

Headers

Body

Schema

Headers

Body

Schema

Clients ¶

Get Client By Device Token ¶

Get Client By Device TokenGET/clients{?applicationId}{&credentialId}{&token}

Deprecation Notice ¶

Example URI

Headers

Body

Schema

Create New Client ¶

Create New ClientPOST/clients

Deprecation Notice ¶

Example URI

Headers

Body

Schema

Headers

Body

Schema

Update a Client ¶

Update a ClientPUT/clients/{clientId}

Deprecation Notice ¶

Example URI

Headers

Body

Schema

Headers

Body

Schema

Events ¶

Create New Event ¶

Create New EventPOST/events

Deprecation Notice ¶

Example URI

Headers

Body

Schema

Headers

Body

Schema

Segments ¶

Segment Query ¶

Get Segments ¶

Get SegmentsGET/segments{?applicationId}{&credentialId}{&page}{&limit}

Deprecation Notice ¶

Example URI

Headers

Body

Schema

Get Segment Size ¶

Get Segment SizeGET/segments/size{?applicationId}{&credentialId}{&condition}

Deprecation Notice ¶

Example URI

Headers

Body

Schema

Create New Segment ¶

Create New SegmentPOST/segments

Deprecation Notice ¶

Example URI

Headers

Body

Schema

Headers

Deprecation Notice

Get Notifications
GET`/notifications{?applicationId}{&credentialId}{&page}{&limit}`

Create New Notification
POST`/notifications`

Get Client By Device Token
GET`/clients{?applicationId}{&credentialId}{&token}`

Deprecation Notice

Create New Client
POST`/clients`

Deprecation Notice

Update a Client
PUT`/clients/{clientId}`

Deprecation Notice

Create New Event
POST`/events`

Deprecation Notice

Segment Query

Get Segments
GET`/segments{?applicationId}{&credentialId}{&page}{&limit}`

Deprecation Notice

Get Segment Size
GET`/segments/size{?applicationId}{&credentialId}{&condition}`

Deprecation Notice

Create New Segment
POST`/segments`

Deprecation Notice

Update a Segment
PUT`/segments/{segmentId}`

Deprecation Notice

Get Tag
GET`/tags{?applicationId}{&credentialId}{&name}`

Deprecation Notice

Get Tag Clients By Tag Id
GET`/tags{?tagId}{&credentialId}{&exclusiveClientId}{&limit}{&order}`

Deprecation Notice

Get Tag Clients By Client Id
GET`/tags{?clientId}{&credentialId}{&type}{&exclusiveTagId}{&limit}{&order}`

Deprecation Notice

Create New Tags
POST`/tags`

Deprecation Notice

Create New Tag By Client Id
POST`/tags`

Deprecation Notice

Create New Tag By Device Token
POST`/tags`

Deprecation Notice