Referência da API

Códigos de erro

Todo erro de /v1 tem o mesmo corpo. error é um código estável pelo qual você pode ramificar; message explica o erro em uma frase e docs traz o link para cá.

As mensagens de erro estão em inglês, como a API as devolve; a tradução aparece logo abaixo.

{
  "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"
}
CódigoStatusMensagem
missing_api_key401Send the key in the Authorization: Bearer header or x-api-key.Envie a chave no cabeçalho Authorization: Bearer ou em x-api-key.
invalid_api_key401The key is not valid.A chave não é válida.
invalid_token401The access token is not valid or has expired.O token de acesso não é válido ou expirou.
account_deleted401The account behind this key was deleted.A conta por trás desta chave foi excluída.
key_expired401The key has expired. Create a new one in Settings › API.A chave expirou. Crie uma nova em Configurações › API.
key_revoked401The key was revoked.A chave foi revogada.
key_budget_reached402This key has used its monthly credit budget. Raise or remove the budget in Settings › API; other keys are not affected.Esta chave usou todo o orçamento mensal de créditos. Aumente ou remova o orçamento em Configurações › API; as outras chaves não são afetadas.
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.Este espaço de trabalho tem mais chaves ativas do que o plano permite, então esta chave está suspensa. Exclua uma chave em Configurações › API ou faça upgrade do plano.
key_leaked401The key was revoked after it was found in a public repository. Create a new one in Settings › API.A chave foi revogada depois de ser encontrada em um repositório público. Crie uma nova em Configurações › API.
ip_not_allowed403This key is restricted to other IP addresses (Settings › API › IP allow list).Esta chave está restrita a outros endereços IP (Configurações › API › Lista de IPs permitidos).
key_paused403The key is paused. Resume it in Settings › API.A chave está pausada. Retome em Configurações › API.
plan_required403The API is on the Pro plan and above; MCP is on every plan.A API está no plano Pro e acima; o MCP está em todos os planos.
scope_required403The key does not carry the scope this endpoint needs.A chave não tem o escopo de que este endpoint precisa.
app_not_allowed403The key is restricted to other apps.A chave está restrita a outros apps.
credits_exhausted402This month's API credits are used up.Os créditos de API deste mês acabaram.
rate_limited429Too many requests for this key. Slow down and retry.Muitas solicitações para esta chave. Reduza o ritmo e tente de novo.
daily_hive_limit429Today's Hive request allowance is used up. It resets at 00:00 UTC.A cota de solicitações do Hive de hoje acabou. Ela é renovada às 00:00 UTC.
bad_country400Send a two-letter storefront code, e.g. country=us.Envie um código de loja de duas letras, ex.: country=us.
unsupported_platform400This metric source supports iOS. Send platform=ios.Esta fonte de métricas é compatível com iOS. Envie platform=ios.
bad_days400Send a whole number of days between 1 and 90.Envie um número inteiro de dias entre 1 e 90.
hive_read_failed400Hive could not read this observation. Retry shortly.O Hive não conseguiu ler esta observação. Tente de novo em instantes.
hive_write_failed400Hive could not save this observation. Retry shortly.O Hive não conseguiu salvar esta observação. Tente de novo em instantes.
bad_kind400kind must be one of grossing, free, paid, ipad.kind deve ser um destes: grossing, free, paid, ipad.
bad_genre400Send genre as an App Store genre id (e.g. 6014) or a category key such as games.Envie genre como um id de gênero da App Store (ex.: 6014) ou uma chave de categoria, como games.
bad_day400Send day as YYYY-MM-DD, no later than yesterday.Envie day como YYYY-MM-DD, no máximo ontem.
bad_goal400Send goal as downloads, rank or revenue.Envie goal como downloads, rank ou revenue.
bad_range400Send from and to as YYYY-MM-DD, from on or before to.Envie from e to como YYYY-MM-DD, com from igual ou anterior a to.
bad_term400Send a keyword of 1–150 characters.Envie uma palavra-chave de 1–150 caracteres.
bad_app_id400Send an App Store id (digits) or a Play package name.Envie um id da App Store (dígitos) ou um nome de pacote do 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.Esta fonte não está conectada ao espaço de trabalho. Conecte em Configurações › Conexões.
bad_query400Send q with 1–120 characters.Envie q com 1–120 caracteres.
bad_id400Send an id from a /v1/search result.Envie um id de um resultado de /v1/search.
no_filters400Send at least one filter; the accepted filters are listed in filters.Envie pelo menos um filtro; os filtros aceitos estão listados em filters.
bad_filter400A filter value is malformed; the field is named in the response. Ranges take numbers, min on or below max.O valor de um filtro está malformado; o campo é indicado na resposta. Intervalos aceitam números, com min igual ou menor que max.
bad_cursor400The cursor is malformed or expired. Pass meta.pagination.nextCursor from the previous response unchanged.O cursor está malformado ou expirou. Envie meta.pagination.nextCursor da resposta anterior sem alterações.
bad_ids400Send ids as a comma-separated list, between min and max apps.Envie ids como uma lista separada por vírgula, com entre min e max apps.
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/apiEste endpoint não está aberto nesta conta. Os endpoints do Hive funcionam com créditos de API comprados ou com o Hive Explorer; lacunas de palavras-chave, pesquisa de palavras-chave e métricas de palavras-chave são exclusivas do Hive Explorer. Veja 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.Leituras são GET; POST é aceito em /v1/actions, /v1/actions/confirm, /v1/apps/{id}/validate-listing e /v1/hive/keywords/{term}/metrics/measure.
bad_metrics400metrics is a list of popularity and/or difficulty, each at most once.metrics é uma lista com popularity e/ou difficulty, cada uma no máximo uma vez.
bad_wait400wait is a whole number of seconds from 0 to 20.wait é um número inteiro de segundos de 0 a 20.
hive_measurement_unavailable503Hive measurement is not available right now. Nothing was used; retry shortly.A medição do Hive não está disponível no momento. Nada foi consumido; tente de novo em instantes.
hive_measurement_queue_failed503The measurement could not be queued. Nothing was charged; retry shortly.Não foi possível colocar a medição na fila. Nada foi cobrado; tente de novo em instantes.
hive_measurement_failed503The source attempt failed. Valid metrics stay in the response; retry later.A tentativa com a fonte falhou. As métricas válidas continuam na resposta; tente de novo mais tarde.
hive_measurement_incomplete503The job finished without a result for every requested metric. Valid metrics stay in the response.O trabalho terminou sem um resultado para cada métrica solicitada. As métricas válidas continuam na resposta.
hive_measurement_deferred503The source deferred this job. Valid metrics stay in the response; retry later.A fonte adiou este trabalho. As métricas válidas continuam na resposta; tente de novo mais tarde.
hive_measurement_not_started503No measurement job is running for this keyword. Retry the request.Não há trabalho de medição em andamento para esta palavra-chave. Repita a solicitação.
unknown_action400No such action. Call POST /v1/actions with one of the listed actions.Essa ação não existe. Chame POST /v1/actions com uma das ações listadas.
invalid_arguments400An argument is missing or malformed; the field is named in the response.Um argumento está ausente ou malformado; o campo é indicado na resposta.
confirm_token_invalid400The confirmation token is unknown or was already used. Preview the action again.O token de confirmação é desconhecido ou já foi usado. Gere a prévia da ação de novo.
confirm_token_expired400The confirmation token expired. Preview the action again.O token de confirmação expirou. Gere a prévia da ação de novo.
confirm_token_mismatch409The target changed after the preview. Preview the action again and re-read the diff.O alvo mudou depois da prévia. Gere a prévia da ação de novo e releia o diff.
write_limit_reached403This write is outside the guardrails for the action (see reason).Esta gravação está fora das proteções da ação (veja 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.Chaves de API não são aceitas na URL, onde logs e proxies as guardam. Envie a chave no cabeçalho x-api-key (ou Authorization: Bearer) e troque esta por uma nova.
test_key_read_only403Test keys (sl_test_) never write.As chaves de teste (sl_test_) nunca gravam.
job_not_found404No such job in this workspace.Esse trabalho não existe neste espaço de trabalho.
workspace_suspended403This workspace is suspended. Contact support@storelift.net.Este espaço de trabalho está suspenso. Entre em contato com support@storelift.net.
ip_list_required403This workspace requires every key to carry an IP allow list. Add one in Settings › API.Este espaço de trabalho exige que toda chave tenha uma lista de IPs permitidos. Adicione uma em Configurações › API.
already_measuring409A measurement for this app is already running.Já há uma medição em andamento para este app.
ai_limit429This month's AI visibility runs are used. The response carries limit and resetsAt.As execuções de visibilidade em IA deste mês acabaram. A resposta traz limit e resetsAt.
in_progress409A write for this target is already running. Wait for it to finish.Já há uma gravação em andamento para este alvo. Aguarde a conclusão.
asc_required403Connect App Store Connect under Settings › Connections first.Conecte antes o App Store Connect em Configurações › Conexões.
asc_role403The App Store Connect key needs the Admin or App Manager role to edit metadata.A chave do App Store Connect precisa da função Admin ou App Manager para editar os metadados.
asc_rejected502App Store Connect refused the change; its own message is in detail.O App Store Connect recusou a mudança; a mensagem dele está em detail.
asc_unavailable502App Store Connect could not be reached. Retry in a moment.Não foi possível acessar o App Store Connect. Tente de novo em instantes.
ios_only403This action needs the App Store side of the app.Esta ação precisa do lado App Store do app.
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.Não há versão editável na App Store. Os metadados só podem mudar enquanto uma versão está em Prepare for Submission ou rejeitada; os estados atuais estão listados.
locale_not_found404That storefront language is not on the version; the available locales are listed.Esse idioma de loja não está na versão; as localidades disponíveis estão listadas.
changed_since_preview409The listing changed in App Store Connect after the preview. Nothing was written — preview again.A página da loja mudou no App Store Connect depois da prévia. Nada foi gravado; gere a prévia de novo.
ai_text_limit429This month's AI writing allowance is used up. resetsAt says when it renews; Settings › Plan adds more.A cota de textos com IA deste mês acabou. resetsAt informa quando ela é renovada; em Configurações › Plano você adiciona mais.
ai_not_configured503The AI writer is starting up. Retry in a moment.O redator de IA está iniciando. Tente de novo em instantes.
ai_failed502The AI writer returned an answer we could not read. Retry in a moment.O redator de IA retornou uma resposta que não conseguimos ler. Tente de novo em instantes.
audit_failed502The storefront scan stopped midway. Start it again with refresh.A varredura de lojas parou no meio. Inicie de novo com refresh.
review_ai_limit429This month's Review AI allowance is used up. resetsAt says when it renews; Settings › Plan adds more.A cota de IA de avaliações deste mês acabou. resetsAt informa quando ela é renovada; em Configurações › Plano você adiciona mais.
review_not_found404No review with that id in the stored reviews for this storefront. Take the id from get_reviews or search_reviews.Não há avaliação com esse id entre as avaliações guardadas desta loja. Pegue o id em get_reviews ou search_reviews.
bad_locale400The locale is two letters, an underscore and two letters, e.g. de_de, pt_br.A localidade são duas letras, um sublinhado e duas letras, ex.: 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.A localização escreve a partir da página de origem da varredura de lojas. Execute get_storefront_audit com start para este app e chame de novo.
no_storefront409No storefront of this app reads that locale. Pick a locale the storefront audit lists.Nenhuma loja deste app lê essa localidade. Escolha uma localidade que a varredura de lojas lista.
measure_busy503Apple's search is answering slowly this minute; call again shortly. Nothing was used.A busca da Apple está respondendo devagar neste momento; chame de novo em instantes. Nada foi consumido.
localize_quota429This plan's listing writes for the period are used. The response carries limit, used and period.As escritas de página da loja deste plano para o período acabaram. A resposta traz limit, used e period.
no_job404No localization is running for that locale. Call without poll to start one.Não há localização em andamento para essa localidade. Chame sem poll para iniciar uma.
ai_timeout504The AI writer took too long. Retry in a moment; the allowance was returned.O redator de IA demorou demais. Tente de novo em instantes; a cota foi devolvida.
not_found404No such app in this workspace.Esse app não existe neste espaço de trabalho.
unknown_endpoint404No such endpoint.Esse endpoint não existe.