Documentação para desenvolvedores › Referência da API

Endpoints de conta

O plano, os escopos e o uso da própria chave, a busca na conta e o feed de alertas. Ler o plano e o uso custa 0 créditos.

Autenticação · Créditos · Parâmetros comuns · Códigos de erro · openapi.json

GET /alerts

O feed de alertas deste espaço de trabalho — quedas e subidas de posição, palavras-chave que entram nos resultados ou saem deles, concorrentes que ultrapassam você ou são ultrapassados, mudanças nas páginas da loja dos concorrentes, etapas de regras e da taxa de gestão do Apple Ads, descobertas de palavras-chave concluídas —, do mais recente para o mais antigo, com a contagem de não lidos. É o mesmo feed do sino do painel.

Escopo
apps:read
Créditos
1
Plano
Free
ParâmetroLocalTipoDescrição
limitquerynumberlinhas, até 500 (padrão 50)
curl "https://storelift.net/v1/alerts" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

GET /portfolio

O dia de hoje em todos os apps do espaço de trabalho, uma linha por app: usuários ao vivo, usuários e novos usuários, receita de anúncios, receita de assinaturas e testes gratuitos, além dos totais do portfólio, dos cartões por hora e por país e do feed de eventos de assinatura. São os mesmos números da tela Hoje do painel. Envie day para consultar um dia anterior.

Escopo
apps:read
Créditos
2
Plano
Free
ParâmetroLocalTipoDescrição
tzquerystringfuso horário IANA para o limite do dia, ex.: Europe/Istanbul (padrão UTC)
dayquerystringdia anterior no formato YYYY-MM-DD (padrão: hoje)
curl "https://storelift.net/v1/portfolio" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

GET /account

A quem pertence esta chave ou sessão: plano, como se autenticou, os escopos que carrega, os apps que pode ler e o saldo de créditos. Não consome créditos. Chame quando uma chamada for recusada por motivo de plano, escopo ou app.

Escopo
nenhum
Créditos
0
curl "https://storelift.net/v1/account" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

Abrir no sandbox

Resposta de exemplo

GET /usage

Todas as cotas do espaço de trabalho, com o que foi usado e o horário de renovação: palavras-chave acompanhadas, apps, descoberta, perguntas à IA, IA de avaliações, visibilidade em IA, espião, créditos de API, a cota do Hive de hoje e o limite por segundo. Não consome créditos. used=null significa que a cota não é medida neste plano, e não que seja zero.

Escopo
nenhum
Créditos
0
curl "https://storelift.net/v1/usage" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

Abrir no sandbox

Resposta de exemplo

GET /fetch

O registro completo de um id retornado por search: o cartão de um app, uma palavra-chave acompanhada com seu estado atual e histórico de posições, ou um concorrente com as palavras-chave em que ele supera o usuário. Retorna id, title, url, um texto de uma linha e metadata.

Escopo
apps:read
Créditos
1
Plano
Free
ParâmetroLocalTipoDescrição
idobrigatórioquerystringum id exatamente como search retornou (app:…, kw:…, rival:…)
curl "https://storelift.net/v1/fetch?id=kw%3Asbx-lumen%3Aus%3Asleep%2520sounds" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

Abrir no sandbox

Resposta de exemplo