API リファレンス

エラーコード

/v1 からのエラーはすべて同じ本文を持ちます。error は分岐に使える安定したコードで、message は一文でその内容を説明し、docs はこのページにリンクします。

エラーメッセージは API が返すとおり英語で掲載し、その下に日本語訳を添えています。

{
  "error": "scope_required",
  "scope": "revenue:read",
  "message": "The key does not carry the scope this endpoint needs.",
  "docs": "https://storelift.net/docs/api/errors#scope_required"
}
コードステータスメッセージ
missing_api_key401Send the key in the Authorization: Bearer header or x-api-key.キーを Authorization: Bearer ヘッダーまたは x-api-key で送ってください。
invalid_api_key401The key is not valid.キーが無効です。
invalid_token401The access token is not valid or has expired.アクセストークンが無効か、期限が切れています。
account_deleted401The account behind this key was deleted.このキーのアカウントは削除されました。
key_expired401The key has expired. Create a new one in Settings › API.キーの期限が切れています。「設定 › API」で新しいキーを作成してください。
key_revoked401The key was revoked.キーは取り消されました。
key_budget_reached402This key has used its monthly credit budget. Raise or remove the budget in Settings › API; other keys are not affected.このキーは月間クレジット予算を使い切りました。「設定 › API」で予算を引き上げるか外してください。ほかのキーには影響しません。
key_limit403This workspace has more live keys than it is entitled to, so this key is on hold. Delete a key in Settings › API or upgrade the plan.このワークスペースには、利用できる数を超える本番キーがあるため、このキーは保留中です。「設定 › API」でキーを削除するか、プランをアップグレードしてください。
key_leaked401The key was revoked after it was found in a public repository. Create a new one in Settings › API.キーは公開リポジトリで見つかったため、取り消されました。「設定 › API」で新しいキーを作成してください。
ip_not_allowed403This key is restricted to other IP addresses (Settings › API › IP allow list).このキーはほかのIPアドレスに制限されています(設定 › API › IP許可リスト)。
key_paused403The key is paused. Resume it in Settings › API.キーは一時停止中です。「設定 › API」で再開してください。
plan_required403The API is on the Pro plan and above; MCP is on every plan.APIはProプラン以上、MCPはすべてのプランで使えます。
scope_required403The key does not carry the scope this endpoint needs.このキーには、このエンドポイントに必要なスコープがありません。
app_not_allowed403The key is restricted to other apps.このキーはほかのアプリに制限されています。
credits_exhausted402This month's API credits are used up.今月のAPIクレジットを使い切りました。
rate_limited429Too many requests for this key. Slow down and retry.このキーのリクエストが多すぎます。間隔を空けて再試行してください。
daily_hive_limit429Today's Hive request allowance is used up. It resets at 00:00 UTC.今日のHiveリクエスト利用枠を使い切りました。00:00 UTCにリセットされます。
bad_country400Send a two-letter storefront code, e.g. country=us.2文字のストアフロントコードを送ってください。例:country=us。
unsupported_platform400This metric source supports iOS. Send platform=ios.この指標のソースはiOSに対応しています。platform=ios を送ってください。
bad_days400Send a whole number of days between 1 and 90.1〜90の整数で日数を送ってください。
hive_read_failed400Hive could not read this observation. Retry shortly.Hiveはこの観測値を読み取れませんでした。しばらくしてから再試行してください。
hive_write_failed400Hive could not save this observation. Retry shortly.Hiveはこの観測値を保存できませんでした。しばらくしてから再試行してください。
bad_kind400kind must be one of grossing, free, paid, ipad.kind は grossing、free、paid、ipad のいずれかです。
bad_genre400Send genre as an App Store genre id (e.g. 6014) or a category key such as games.genre は App StoreのジャンルID(例:6014)または games などのカテゴリキーで送ってください。
bad_day400Send day as YYYY-MM-DD, no later than yesterday.day は YYYY-MM-DD 形式で、昨日以前の日付を送ってください。
bad_goal400Send goal as downloads, rank or revenue.goal は downloads、rank、revenue のいずれかで送ってください。
bad_range400Send from and to as YYYY-MM-DD, from on or before to.from と to は YYYY-MM-DD 形式で、from が to 以前になるように送ってください。
bad_term400Send a keyword of 1–150 characters.1〜150文字のキーワードを送ってください。
bad_app_id400Send an App Store id (digits) or a Play package name.App Store ID(数字)またはPlayのパッケージ名を送ってください。
not_measured404No verified observation is available for the requested app, keyword or scope. Missing data is not zero. Check the request parameters and follow the linked documentation for available actions.
not_connected404This source is not connected to the workspace. Connect it under Settings › Connections.このソースはワークスペースに連携されていません。「設定 › 連携」で連携してください。
bad_query400Send q with 1–120 characters.q は1〜120文字で送ってください。
bad_id400Send an id from a /v1/search result./v1/search の結果に含まれるIDを送ってください。
no_filters400Send at least one filter; the accepted filters are listed in filters.フィルターを1つ以上送ってください。使えるフィルターは filters に一覧があります。
bad_filter400A filter value is malformed; the field is named in the response. Ranges take numbers, min on or below max.フィルターの値の形式が正しくありません。該当するフィールドは応答に示されます。範囲には数値を指定し、min は max 以下にします。
bad_cursor400The cursor is malformed or expired. Pass meta.pagination.nextCursor from the previous response unchanged.カーソルの形式が正しくないか、期限が切れています。前の応答の meta.pagination.nextCursor をそのまま渡してください。
bad_ids400Send ids as a comma-separated list, between min and max apps.ids はカンマ区切りのリストで、min 以上 max 以下の数のアプリを送ってください。
explorer_required403This endpoint is not open on this account. Hive endpoints run on purchased API credits or Hive Explorer; keyword gap, keyword research and keyword metrics are Hive Explorer only. See https://storelift.net/hive/apiこのエンドポイントはこのアカウントでは利用できません。Hiveのエンドポイントは、購入したAPIクレジットまたはHive Explorerで動きます。キーワードギャップ、キーワード調査、キーワード指標はHive Explorer専用です。https://storelift.net/hive/api をご覧ください
method_not_allowed405Reads are GET; POST is taken on /v1/actions, /v1/actions/confirm, /v1/apps/{id}/validate-listing and /v1/hive/keywords/{term}/metrics/measure.読み取りはGETです。POSTを受け付けるのは /v1/actions、/v1/actions/confirm、/v1/apps/{id}/validate-listing、/v1/hive/keywords/{term}/metrics/measure です。
bad_metrics400metrics is a list of popularity and/or difficulty, each at most once.metrics は popularity と difficulty の一方または両方のリストで、それぞれ1回までです。
bad_wait400wait is a whole number of seconds from 0 to 20.wait は0〜20の整数(秒)です。
hive_measurement_unavailable503Hive measurement is not available right now. Nothing was used; retry shortly.Hiveの計測は現在利用できません。何も消費されていません。しばらくしてから再試行してください。
hive_measurement_queue_failed503The measurement could not be queued. Nothing was charged; retry shortly.計測をキューに入れられませんでした。課金はされていません。しばらくしてから再試行してください。
hive_measurement_failed503The source attempt failed. Valid metrics stay in the response; retry later.ソースへの試行が失敗しました。有効な指標は応答に残ります。あとで再試行してください。
hive_measurement_incomplete503The job finished without a result for every requested metric. Valid metrics stay in the response.ジョブは、要求された指標の一部で結果が得られないまま終了しました。有効な指標は応答に残ります。
hive_measurement_deferred503The source deferred this job. Valid metrics stay in the response; retry later.ソースがこのジョブを先送りしました。有効な指標は応答に残ります。あとで再試行してください。
hive_measurement_not_started503No measurement job is running for this keyword. Retry the request.このキーワードの計測ジョブは実行されていません。リクエストを再試行してください。
unknown_action400No such action. Call POST /v1/actions with one of the listed actions.そのようなアクションはありません。一覧にあるアクションのいずれかで POST /v1/actions を呼び出してください。
invalid_arguments400An argument is missing or malformed; the field is named in the response.引数が不足しているか、形式が正しくありません。該当するフィールドは応答に示されます。
confirm_token_invalid400The confirmation token is unknown or was already used. Preview the action again.確認トークンが不明か、すでに使用済みです。アクションをもう一度プレビューしてください。
confirm_token_expired400The confirmation token expired. Preview the action again.確認トークンの期限が切れました。アクションをもう一度プレビューしてください。
confirm_token_mismatch409The target changed after the preview. Preview the action again and re-read the diff.プレビューのあとに対象が変更されました。アクションをもう一度プレビューし、差分を読み直してください。
write_limit_reached403This write is outside the guardrails for the action (see reason).この書き込みは、このアクションのガードレールの範囲外です(reason を参照)。
key_in_url400API keys are not accepted in the URL, where logs and proxies keep them. Send the key in the x-api-key header (or Authorization: Bearer) and rotate this one.APIキーはURLでは受け付けません。URLはログやプロキシに残るためです。キーは x-api-key ヘッダー(または Authorization: Bearer)で送り、このキーはローテーションしてください。
test_key_read_only403Test keys (sl_test_) never write.テストキー(sl_test_)は決して書き込みません。
job_not_found404No such job in this workspace.このワークスペースにそのようなジョブはありません。
workspace_suspended403This workspace is suspended. Contact support@storelift.net.このワークスペースは停止されています。support@storelift.net にお問い合わせください。
ip_list_required403This workspace requires every key to carry an IP allow list. Add one in Settings › API.このワークスペースでは、すべてのキーにIP許可リストが必要です。「設定 › API」で追加してください。
already_measuring409A measurement for this app is already running.このアプリの計測はすでに実行中です。
ai_limit429This month's AI visibility runs are used. The response carries limit and resetsAt.今月のAI可視性の実行回数を使い切りました。応答に limit と resetsAt が含まれます。
in_progress409A write for this target is already running. Wait for it to finish.この対象への書き込みはすでに実行中です。完了するまでお待ちください。
asc_required403Connect App Store Connect under Settings › Connections first.先に「設定 › 連携」でApp Store Connectを連携してください。
asc_role403The App Store Connect key needs the Admin or App Manager role to edit metadata.メタデータを編集するには、App Store Connectのキーに Admin または App Manager のロールが必要です。
asc_rejected502App Store Connect refused the change; its own message is in detail.App Store Connectが変更を拒否しました。App Store Connect側のメッセージは detail にあります。
asc_unavailable502App Store Connect could not be reached. Retry in a moment.App Store Connectに接続できませんでした。少ししてから再試行してください。
ios_only403This action needs the App Store side of the app.このアクションには、アプリのApp Store側が必要です。
no_editable_version404No editable App Store version. Metadata can only change while a version is in Prepare for Submission or rejected — the current states are listed.編集できるApp Storeバージョンがありません。メタデータを変更できるのは、バージョンが「提出準備中」または却下の状態にある間だけです。現在の状態は一覧にあります。
locale_not_found404That storefront language is not on the version; the available locales are listed.そのストアフロント言語はこのバージョンにありません。利用できるロケールは一覧にあります。
changed_since_preview409The listing changed in App Store Connect after the preview. Nothing was written — preview again.プレビューのあと、App Store Connectで掲載情報が変更されました。何も書き込まれていません。もう一度プレビューしてください。
ai_text_limit429This month's AI writing allowance is used up. resetsAt says when it renews; Settings › Plan adds more.今月のAIライティング利用枠を使い切りました。更新日時は resetsAt で分かります。「設定 › プラン」で追加できます。
ai_not_configured503The AI writer is starting up. Retry in a moment.AIライターを起動しています。少ししてから再試行してください。
ai_failed502The AI writer returned an answer we could not read. Retry in a moment.AIライターが読み取れない応答を返しました。少ししてから再試行してください。
audit_failed502The storefront scan stopped midway. Start it again with refresh.ストアフロントのスキャンが途中で止まりました。refresh でもう一度開始してください。
review_ai_limit429This month's Review AI allowance is used up. resetsAt says when it renews; Settings › Plan adds more.今月のレビューAI利用枠を使い切りました。更新日時は resetsAt で分かります。「設定 › プラン」で追加できます。
review_not_found404No review with that id in the stored reviews for this storefront. Take the id from get_reviews or search_reviews.このストアフロントの保存済みレビューに、そのIDのレビューはありません。IDは get_reviews または search_reviews から取得してください。
bad_locale400The locale is two letters, an underscore and two letters, e.g. de_de, pt_br.ロケールは、2文字、アンダースコア、2文字の形式です。例:de_de、pt_br。
no_audit409Localization writes from the storefront audit's source listing. Run get_storefront_audit with start for this app, then call again.ローカライズは、ストアフロント監査の元の掲載情報をもとに書きます。このアプリで get_storefront_audit を start 付きで実行してから、もう一度呼び出してください。
no_storefront409No storefront of this app reads that locale. Pick a locale the storefront audit lists.このアプリのどのストアフロントも、そのロケールを読みません。ストアフロント監査に載っているロケールを選んでください。
measure_busy503Apple's search is answering slowly this minute; call again shortly. Nothing was used.Appleの検索の応答が今は遅くなっています。しばらくしてからもう一度呼び出してください。何も消費されていません。
localize_quota429This plan's listing writes for the period are used. The response carries limit, used and period.このプランの今期の掲載文作成回数を使い切りました。応答に limit、used、period が含まれます。
no_job404No localization is running for that locale. Call without poll to start one.そのロケールで実行中のローカライズはありません。開始するには poll なしで呼び出してください。
ai_timeout504The AI writer took too long. Retry in a moment; the allowance was returned.AIライターの処理に時間がかかりすぎました。少ししてから再試行してください。利用枠は戻されました。
not_found404No such app in this workspace.このワークスペースにそのようなアプリはありません。
unknown_endpoint404No such endpoint.そのようなエンドポイントはありません。