アカウントのエンドポイント
キー自身のプラン、スコープ、利用状況と、アカウント内の検索、アラートのフィード。プランと利用状況の読み取りは 0 クレジットです。
認証 · クレジット · 共通パラメータ · エラーコード · openapi.json
GET /alerts
このワークスペースのアラートフィードです。順位の下落と上昇、検索結果へのキーワードの出入り、競合に抜かれた・抜いた動き、競合の掲載情報の変更、Apple Adsのルールと管理手数料のステップ、完了したキーワード発見の実行を、新しい順に未読数とともに返します。ダッシュボードのベルと同じフィードです。
| パラメータ | 場所 | 型 | 説明 |
|---|---|---|---|
limit | query | number | 行数。最大500(既定は50) |
curl "https://storelift.net/v1/alerts" \
-H "Authorization: Bearer $STORELIFT_API_KEY"GET /portfolio
ワークスペース内の全アプリの今日を、アプリごとに1行で返します。ライブユーザー、ユーザーと新規ユーザー、広告収益、サブスクリプション収益とトライアルに加え、ポートフォリオ合計、時間別・国別のカード、サブスクリプションイベントのフィードが含まれます。ダッシュボードの「今日」画面と同じ数値です。過去の日は day で指定します。
| パラメータ | 場所 | 型 | 説明 |
|---|---|---|---|
tz | query | string | 日の区切りに使うIANAタイムゾーン。例:Europe/Istanbul(既定はUTC) |
day | query | string | 過去の日。YYYY-MM-DD形式(既定は今日) |
curl "https://storelift.net/v1/portfolio" \
-H "Authorization: Bearer $STORELIFT_API_KEY"GET /account
このキーまたはセッションの持ち主を返します。プラン、認証方法、付与されたスコープ、読み取れるアプリ、クレジット残高です。クレジットは消費しません。プラン・スコープ・アプリが理由で呼び出しが拒否されたときに呼び出してください。
curl "https://storelift.net/v1/account" \
-H "Authorization: Bearer $STORELIFT_API_KEY"サンプルレスポンス
GET /usage
ワークスペースのすべての利用枠を、使用量とリセット時刻とともに返します。追跡キーワード、アプリ、キーワード発見、AIへの質問、レビューAI、AI可視性、競合キーワード調査、APIクレジット、今日のHive利用枠、1秒あたりのレートです。クレジットは消費しません。used=null はゼロではなく、このプランでその利用枠が計量されないことを意味します。
curl "https://storelift.net/v1/usage" \
-H "Authorization: Bearer $STORELIFT_API_KEY"サンプルレスポンス
GET /search
このアカウント自身のレコード(アプリ名とストアID、追跡キーワード、ユーザーより上位にいる競合アプリ)を検索し、fetch に渡すIDの一覧を返します。レコードを探すために使います。ストア全体から新しいアプリを見つけるには find_apps を使ってください。
| パラメータ | 場所 | 型 | 説明 |
|---|---|---|---|
q必須 | query | string | フリーテキスト:アプリ名、キーワード、競合の名前、またはストアID |
curl "https://storelift.net/v1/search?q=sleep" \
-H "Authorization: Bearer $STORELIFT_API_KEY"サンプルレスポンス
GET /fetch
search が返したID 1件の完全なレコードです。アプリカード、現在の状態と順位履歴を含む追跡キーワード1件、またはユーザーを上回っているキーワード付きの競合1件を返します。id、title、url、1行の text、metadata を返します。
| パラメータ | 場所 | 型 | 説明 |
|---|---|---|---|
id必須 | query | string | search が返したままのID(app:…、kw:…、rival:…) |
curl "https://storelift.net/v1/fetch?id=kw%3Asbx-lumen%3Aus%3Asleep%2520sounds" \
-H "Authorization: Bearer $STORELIFT_API_KEY"