# Referência da API

> https://storelift.net/pt/docs/api/

Uma URL base, uma chave, JSON na ida e na volta. Cada endpoint abaixo também é uma ferramenta MCP com o mesmo nome. OpenAPI 3.1: https://storelift.net/openapi.json

## URL base

`https://storelift.net/v1`

Todos os caminhos abaixo são relativos a ela. Envie `GET` para leituras e `POST` só em `/actions`.

## Autenticação

Envie a chave em `Authorization: Bearer <key>` ou em `x-api-key`. Crie as chaves em Configurações › API; cada chave tem escopos, uma lista opcional de IPs permitidos, uma lista opcional de apps e um orçamento mensal opcional de créditos. Uma chave que atinge o orçamento responde `402 key_budget_reached` até a virada do mês; as outras chaves continuam funcionando.

As chaves de produção (`sl_live_`) da API REST estão no Pro e acima, ou em qualquer plano com um pacote de créditos. O Free inclui uma chave de produção que funciona só no servidor MCP. As chaves de teste (`sl_test_`) devolvem os dados do sandbox em todos os planos. Os assistentes fazem login por OAuth pelo [servidor MCP](https://storelift.net/pt/mcp-server/) em todos os planos.

## Créditos e limites

Cada chamada custa os créditos indicados nela; `/account` e `/usage` custam 0, e a prévia de uma escrita custa 0. Toda resposta traz `x-credits-used`, `x-credits-limit`, `x-credits-remaining` e `x-credits-reset`.

As requisições por segundo são definidas por plano; acima disso você recebe `429 rate_limited` com `retry-after`. Os endpoints do Hive abrem com créditos de API comprados ou com o Hive Explorer e também contam para uma cota diária: 500 chamadas com créditos de pacote, 10.000 com o Hive Explorer. [Créditos por chamada](https://storelift.net/pt/hive/api/)

## Sandbox

`https://storelift.net/v1/sandbox` responde a todas as leituras abaixo que têm resposta de exemplo, sem chave e sem créditos. Os dados são fixos e datados, então os testes ficam estáveis.

As chaves de teste (`sl_test_`) devolvem os mesmos dados na URL base de produção e nunca escrevem.

## Como ler uma posição

Uma posição tem três estados, e eles ficam separados: `measured: false` significa que a consulta não foi medida naquele dia, `rank: null` significa que ela foi medida e o app está fora dos resultados lidos, e um número é a posição.

## Erros

Todo erro tem o mesmo corpo: `{ "error": "<code>", "message": "…", "docs": "…" }`. `error` é estável; faça a ramificação por ele, não por `message`. Alguns códigos acrescentam campos como `scope`, `field` ou `limit`. [Todos os códigos de erro](https://storelift.net/pt/docs/api/errors/)

## Exemplos passo a passo

Três trabalhos, da primeira chamada ao resultado que você guarda. Todos os comandos rodam no sandbox, então não gastam créditos nem mudam nada, e cada resposta é a que o sandbox devolve para o comando.

Com a sua própria chave, os caminhos são os mesmos sem `/sandbox` e cada chamada custa os créditos indicados nela. Uma chave de teste (`sl_test_`) também responde ali com os dados do sandbox, por 0 créditos.

### Leve as posições das palavras-chave da semana para um relatório

Leia as palavras-chave de um app em uma loja e guarde uma única linha. Rode toda semana e as linhas formam uma tendência.

Escopo: `apps:read` · Créditos: 2 · 0 no sandbox ou com uma chave de teste · Plano: Sandbox e chave de teste: todos os planos · chave de produção: Pro e acima · Funciona com: API 1.5.0

1. Encontre o id do app.

```sh
curl "https://storelift.net/v1/sandbox/apps"
```

Resposta:

```json
{
  "apps": [
    {
      "id": "sbx-lumen",
      "name": "Lumen — Sleep Sounds",
      "icon": null,
      "iosId": "1000000001",
      "androidPkg": "net.storelift.sandbox.lumen",
      "bundleId": "net.storelift.sandbox.lumen",
      "countries": [
        "us",
        "gb",
        "de"
      ],
      "keywords": [
        "sleep sounds",
        "white noise",
        "rain sounds"
      ],
      "keywordsByCountry": {
        "us": [
          "sleep sounds",
          "white noise",
          "rain sounds"
        ],
        "gb": [
          "sleep sounds",
          "white noise",
          "rain sounds"
        ],
        "de": [
          "sleep sounds",
          "white noise",
          "rain sounds"
        ]
      },
      "manualRivals": null,
      "keywordTags": null,
      "buriedKeywords": null,
      "goal": null,
      "tasksDone": null
    },
    {
      "id": "sbx-quill",
      "name": "Quill Notes",
      "icon": null,
      "iosId": "1000000002",
      "androidPkg": null,
      "bundleId": "net.storelift.sandbox.quill",
      "countries": [
        "us",
        "jp"
      ],
      "keywords": [
        "notes",
        "markdown notes",
        "journal"
      ],
      "keywordsByCountry": {
        "us": [
          "notes",
          "markdown notes",
          "journal"
        ],
        "jp": [
          "notes",
          "markdown notes",
          "journal"
        ]
      },
      "manualRivals": null,
      "keywordTags": null,
      "buriedKeywords": null,
      "goal": null,
      "tasksDone": null
    }
  ]
}
```

2. Leia todas as palavras-chave acompanhadas desse app na loja.

```sh
curl "https://storelift.net/v1/sandbox/apps/sbx-lumen/keywords?country=us"
```

Resposta (keywords: 2 de 8 linhas):

```json
{
  "country": "us",
  "platform": "ios",
  "live": true,
  "measuredAt": "2026-09-27T02:10:00.000Z",
  "keywords": [
    {
      "term": "sleep sounds",
      "measured": true,
      "rank": null,
      "demand": 73,
      "hintCount": 6,
      "popularity": 73,
      "popularitySource": "p2",
      "popularityWeek": null,
      "popularityNone": false,
      "difficulty": 70,
      "difficultyBand": "brutal",
      "difficultyNone": false,
      "popularityMeasuring": false,
      "difficultyMeasuring": false,
      "measuring": false,
      "searchDepth": 200
    },
    {
      "term": "white noise",
      "measured": true,
      "rank": 57,
      "demand": 37,
      "hintCount": 4,
      "popularity": 37,
      "popularitySource": "p2",
      "popularityWeek": null,
      "popularityNone": false,
      "difficulty": 70,
      "difficultyBand": "brutal",
      "difficultyNone": false,
      "popularityMeasuring": false,
      "difficultyMeasuring": false,
      "measuring": false,
      "searchDepth": 200
    }
  ]
}
```

Resuma a resposta na linha que você guarda. Uma palavra-chave com `measured: true` e `rank: null` foi medida e o app não está nos resultados; ela é contada à parte de uma palavra-chave que não foi medida.

```js
function weeklyRow(body) {
  const ranked = body.keywords.filter((k) => k.measured && k.rank !== null);
  const best = ranked.reduce((a, b) => (a && a.rank <= b.rank ? a : b), null);
  return {
    measuredAt: body.measuredAt,
    country: body.country,
    platform: body.platform,
    keywords: body.keywords.length,
    ranked: ranked.length,
    absent: body.keywords.filter((k) => k.measured && k.rank === null).length,
    notMeasured: body.keywords.filter((k) => !k.measured).length,
    best: best && { term: best.term, rank: best.rank },
  };
}
```

Resultado:

```json
{
  "measuredAt": "2026-09-27T02:10:00.000Z",
  "country": "us",
  "platform": "ios",
  "keywords": 8,
  "ranked": 6,
  "absent": 2,
  "notMeasured": 0,
  "best": {
    "term": "nature sounds",
    "rank": 29
  }
}
```

Um id de app que o workspace não tem responde `404`:

```sh
curl "https://storelift.net/v1/sandbox/apps/sbx-unknown/keywords?country=us"
```

```json
{
  "error": "not_found",
  "message": "No such app in this workspace.",
  "docs": "https://storelift.net/docs/api/errors#not_found"
}
```

### Pergunte quem está acima de você

Os mesmos dados pelo [servidor MCP](https://storelift.net/pt/mcp-server/): o assistente faz duas chamadas de ferramenta. Para enviá-las à mão, coloque uma chave de teste em `STORELIFT_TEST_KEY`.

Escopo: `apps:read` · Créditos: 2 · 0 com uma chave de teste · Plano: Chave de teste e OAuth: todos os planos · chave de produção: todos os planos · Funciona com: API 1.5.0 · ferramentas no storelift-mcp 1.1.1

1. `list_apps` devolve o id do app.

```sh
curl "https://storelift.net/mcp" \
  -H "Authorization: Bearer $STORELIFT_TEST_KEY" \
  -H "content-type: application/json" \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"list_apps","arguments":{}}}'
```

Resposta:

```json
{
  "apps": [
    {
      "id": "sbx-lumen",
      "name": "Lumen — Sleep Sounds",
      "icon": null,
      "iosId": "1000000001",
      "androidPkg": "net.storelift.sandbox.lumen",
      "bundleId": "net.storelift.sandbox.lumen",
      "countries": [
        "us",
        "gb",
        "de"
      ],
      "keywords": [
        "sleep sounds",
        "white noise",
        "rain sounds"
      ],
      "keywordsByCountry": {
        "us": [
          "sleep sounds",
          "white noise",
          "rain sounds"
        ],
        "gb": [
          "sleep sounds",
          "white noise",
          "rain sounds"
        ],
        "de": [
          "sleep sounds",
          "white noise",
          "rain sounds"
        ]
      },
      "manualRivals": null,
      "keywordTags": null,
      "buriedKeywords": null,
      "goal": null,
      "tasksDone": null
    },
    {
      "id": "sbx-quill",
      "name": "Quill Notes",
      "icon": null,
      "iosId": "1000000002",
      "androidPkg": null,
      "bundleId": "net.storelift.sandbox.quill",
      "countries": [
        "us",
        "jp"
      ],
      "keywords": [
        "notes",
        "markdown notes",
        "journal"
      ],
      "keywordsByCountry": {
        "us": [
          "notes",
          "markdown notes",
          "journal"
        ],
        "jp": [
          "notes",
          "markdown notes",
          "journal"
        ]
      },
      "manualRivals": null,
      "keywordTags": null,
      "buriedKeywords": null,
      "goal": null,
      "tasksDone": null
    }
  ]
}
```

2. `get_rivals` devolve os apps posicionados acima dele, palavra-chave por palavra-chave.

```sh
curl "https://storelift.net/mcp" \
  -H "Authorization: Bearer $STORELIFT_TEST_KEY" \
  -H "content-type: application/json" \
  -d '{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"get_rivals","arguments":{"appId":"sbx-lumen","country":"us"}}}'
```

Resposta (rivals: 2 de 3 linhas):

```json
{
  "country": "us",
  "platform": "ios",
  "rivals": [
    {
      "id": "1000000101",
      "name": "Calm Rain",
      "ratings": 57046,
      "terms": [
        {
          "term": "sleep sounds",
          "theirRank": 1,
          "ourRank": null
        },
        {
          "term": "white noise",
          "theirRank": 1,
          "ourRank": 57
        }
      ]
    },
    {
      "id": "1000000102",
      "name": "Noisli",
      "ratings": 16114,
      "terms": [
        {
          "term": "sleep sounds",
          "theirRank": 2,
          "ourRank": null
        },
        {
          "term": "white noise",
          "theirRank": 2,
          "ourRank": 57
        }
      ]
    }
  ]
}
```

O que a resposta diz, concorrente por concorrente. `ourRank: null` é uma palavra-chave em que o app não aparece.

```js
function rivalsAhead(body) {
  return body.rivals.map((r) => ({
    name: r.name,
    ratings: r.ratings,
    aheadOn: r.terms.length,
    absentOn: r.terms.filter((t) => t.ourRank === null).length,
  }));
}
```

Resultado:

```json
[
  {
    "name": "Calm Rain",
    "ratings": 57046,
    "aheadOn": 8,
    "absentOn": 2
  },
  {
    "name": "Noisli",
    "ratings": 16114,
    "aheadOn": 8,
    "absentOn": 2
  },
  {
    "name": "Deep Sleep Tones",
    "ratings": 64683,
    "aheadOn": 8,
    "absentOn": 2
  }
]
```

Um id de app que o workspace não tem volta como um erro de ferramenta que o assistente consegue ler, não como uma requisição que falhou:

```sh
curl "https://storelift.net/mcp" \
  -H "Authorization: Bearer $STORELIFT_TEST_KEY" \
  -H "content-type: application/json" \
  -d '{"jsonrpc":"2.0","id":9,"method":"tools/call","params":{"name":"get_rivals","arguments":{"appId":"sbx-unknown","country":"us"}}}'
```

```text
ERROR: No such app in this workspace.
```

### Veja o que uma credencial pode ler, por HTTP ou MCP

A primeira chamada de qualquer integração: qual plano, quais escopos, quais apps e quantos créditos restam. `GET /account` e a ferramenta `whoami` devolvem o mesmo corpo, e nenhuma das duas custa créditos.

Escopo: nenhum · Créditos: 0 · Plano: Sandbox, chave de teste e OAuth: todos os planos · chave de produção: Pro e acima · Funciona com: API 1.5.0 · ferramentas no storelift-mcp 1.5.0

1. Por HTTP.

```sh
curl "https://storelift.net/v1/sandbox/account"
```

Resposta:

```json
{
  "plan": "studio",
  "auth": "test_key",
  "scopes": [
    "apps:read",
    "reviews:read",
    "ai:read",
    "revenue:read",
    "hive:read",
    "hive:spy",
    "hive:estimate",
    "ads:read"
  ],
  "apps": [
    {
      "id": "sbx-lumen",
      "name": "Lumen — Sleep Sounds",
      "countries": [
        "us",
        "gb",
        "de"
      ]
    },
    {
      "id": "sbx-quill",
      "name": "Quill Notes",
      "countries": [
        "us",
        "jp"
      ]
    }
  ],
  "appRestriction": false,
  "credits": {
    "used": 0,
    "limit": 50000,
    "resetsAt": null
  },
  "hive": {
    "perDay": 10000
  },
  "ratePerSecond": 10,
  "docs": "https://storelift.net/guide/storelift-api/"
}
```

2. A mesma resposta como chamada de ferramenta.

```sh
curl "https://storelift.net/mcp" \
  -H "Authorization: Bearer $STORELIFT_TEST_KEY" \
  -H "content-type: application/json" \
  -d '{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"whoami","arguments":{}}}'
```

Resposta:

```json
{
  "plan": "studio",
  "auth": "test_key",
  "scopes": [
    "apps:read",
    "reviews:read",
    "ai:read",
    "revenue:read",
    "hive:read",
    "hive:spy",
    "hive:estimate",
    "ads:read"
  ],
  "apps": [
    {
      "id": "sbx-lumen",
      "name": "Lumen — Sleep Sounds",
      "countries": [
        "us",
        "gb",
        "de"
      ]
    },
    {
      "id": "sbx-quill",
      "name": "Quill Notes",
      "countries": [
        "us",
        "jp"
      ]
    }
  ],
  "appRestriction": false,
  "credits": {
    "used": 0,
    "limit": 50000,
    "resetsAt": null
  },
  "hive": {
    "perDay": 10000
  },
  "ratePerSecond": 10,
  "docs": "https://storelift.net/guide/storelift-api/"
}
```

Confira o escopo que uma chamada exige antes de fazê-la e leia o saldo antes de um lote.

```js
function allowance(body) {
  return {
    plan: body.plan,
    auth: body.auth,
    scopes: body.scopes,
    apps: body.apps.map((a) => a.id),
    creditsLeft: body.credits.limit - body.credits.used,
    ratePerSecond: body.ratePerSecond,
  };
}
```

Resultado:

```json
{
  "plan": "studio",
  "auth": "test_key",
  "scopes": [
    "apps:read",
    "reviews:read",
    "ai:read",
    "revenue:read",
    "hive:read",
    "hive:spy",
    "hive:estimate",
    "ads:read"
  ],
  "apps": [
    "sbx-lumen",
    "sbx-quill"
  ],
  "creditsLeft": 50000,
  "ratePerSecond": 10
}
```

Sem credenciais, o endpoint MCP responde `401` com um erro JSON-RPC, e um cliente compatível com a autorização MCP inicia o login OAuth a partir dele:

```sh
curl "https://storelift.net/mcp" \
  -H "content-type: application/json" \
  -d '{"jsonrpc":"2.0","id":9,"method":"tools/call","params":{"name":"whoami","arguments":{}}}'
```

```json
{
  "jsonrpc": "2.0",
  "id": 9,
  "error": {
    "code": -32001,
    "message": "No credentials were sent. Sign in with OAuth on any plan, or add Authorization: Bearer <your Storelift API key>. Live keys require Pro, Studio, Enterprise, or an eligible Free account with purchased API credits or active Explorer. Tool access still depends on plan, scopes and credits. Generate a key at Storelift → Settings → API keys."
  }
}
```

## Parâmetros comuns

Eles funcionam do mesmo jeito em todos os endpoints que os aceitam; cada endpoint lista os que aceita.

- `appId` (path, string) — app id from list_apps
- `country` (query, string) — country code, e.g. tr, us (defaults to the app's first country)
- `platform` (query, ios | android) — defaults to ios
- `country` (query, string) — storefront code, e.g. us (defaults to us)

## [Conta](https://storelift.net/pt/docs/api/account/)

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.

- [`GET /alerts`](https://storelift.net/pt/docs/api/account/#list_alerts) — The alert feed of this workspace — rank drops and rises, keywords entering or leaving the results, rivals… (1)
- [`GET /portfolio`](https://storelift.net/pt/docs/api/account/#get_portfolio_overview) — Today across every app in the workspace, one row per app: live users, users and new users, ad revenue,… (2)
- [`GET /account`](https://storelift.net/pt/docs/api/account/#whoami) — Who this key or session belongs to: plan, how it authenticated, the scopes it carries, the apps it may… (0)
- [`GET /usage`](https://storelift.net/pt/docs/api/account/#get_usage) — Every quota of the workspace with what is used and the reset time: tracked keywords, apps, discovery, AI… (0)
- [`GET /search`](https://storelift.net/pt/docs/api/account/#search) — Search this account's own records — app names and store ids, tracked keywords, and the rival apps that… (1)
- [`GET /fetch`](https://storelift.net/pt/docs/api/account/#fetch) — The full record behind one id from search: an app card, one tracked keyword with its current state and… (1)

## [Seus apps](https://storelift.net/pt/docs/api/apps/)

Os apps que este workspace acompanha: posições, concorrentes, avaliações, página na loja, linha do tempo da página, destaques, top charts e verificações da página.

- [`GET /apps`](https://storelift.net/pt/docs/api/apps/#list_apps) — List the apps tracked in this Storelift account (id, name, countries, keywords) (1)
- [`GET /apps/{appId}/keywords`](https://storelift.net/pt/docs/api/apps/#get_keywords) — Keyword ranks for one app in one App Store / Google Play country (1)
- [`GET /apps/{appId}/rivals`](https://storelift.net/pt/docs/api/apps/#get_rivals) — Apps that rank ABOVE this app in search (1)
- [`GET /apps/{appId}/ai`](https://storelift.net/pt/docs/api/apps/#get_ai_visibility) — App mentions in a dated sample of AI engine answers; this does not reproduce what ChatGPT, Claude or… (1)
- [`GET /apps/{appId}/ai-check`](https://storelift.net/pt/docs/api/apps/#run_ai_visibility_check) — Start an AI visibility sample for one app in one country, with the engines available for the run (1)
- [`GET /apps/{appId}/history`](https://storelift.net/pt/docs/api/apps/#get_history) — Keyword rank history for one country (1)
- [`GET /apps/{appId}/page`](https://storelift.net/pt/docs/api/apps/#get_store_page) — The app's own store listing signals for one country (name and subtitle are not included): version, in-app… (1)
- [`GET /apps/{appId}/reviews`](https://storelift.net/pt/docs/api/apps/#get_reviews) — Recent reviews for one country: `list` holds the App Store reviews, `android` the Google Play reviews (a… (1)
- [`GET /apps/{appId}/charts`](https://storelift.net/pt/docs/api/apps/#get_charts) — App Store chart position for one country: current ranks per list (free / paid / grossing, overall and in… (1)
- [`GET /apps/{appId}/reviews/search`](https://storelift.net/pt/docs/api/apps/#search_reviews) — Search one app's reviews in one storefront by text, star rating, app version and date range, newest first… (1)
- [`GET /apps/{appId}/reviews/stats`](https://storelift.net/pt/docs/api/apps/#get_review_stats) — Star-rating distribution, average and share of 1–2 star reviews for one app in one storefront, plus a… (1)
- [`GET /apps/{appId}/reviews/summary`](https://storelift.net/pt/docs/api/apps/#summarize_reviews) — Review AI for one app in one storefront: a summary of the recent reviews and the themes in them —… (1)
- [`GET /apps/{appId}/reviews/reply-draft`](https://storelift.net/pt/docs/api/apps/#draft_review_reply) — A developer reply draft for one review, in the storefront's language (1)
- [`GET /apps/{appId}/timeline`](https://storelift.net/pt/docs/api/apps/#get_listing_timeline) — Dated changes to one app's listing — new version, screenshots, in-app events, featuring from the store… (1)
- [`GET /apps/{appId}/today`](https://storelift.net/pt/docs/api/apps/#get_today) — One app's day in one answer — the Today screen: purchases, trials and renewals from the connected sources,… (1)
- [`GET /apps/{appId}/competition`](https://storelift.net/pt/docs/api/apps/#get_keyword_competition) — How many apps compete on each keyword in one storefront, returned for terms seen on two or more apps (1)
- [`GET /apps/{appId}/rivals/{rivalId}`](https://storelift.net/pt/docs/api/apps/#get_rival_detail) — One rival of your app in one storefront: its name, rating and rating count with a 90-day history of them… (1)
- [`GET /apps/{appId}/rivals/{rivalId}/adnetworks`](https://storelift.net/pt/docs/api/apps/#get_rival_ad_networks) — How a rival monetises with ads: the ad networks it works with, each marked DIRECT or RESELLER (1)
- [`GET /apps/{appId}/rivals/{rivalId}/market`](https://storelift.net/pt/docs/api/apps/#get_rival_market) — A rival's market in one storefront: on Google Play the exact install count and in-app purchase price… (1)
- [`GET /apps/{appId}/storefront-audit`](https://storelift.net/pt/docs/api/apps/#get_storefront_audit) — Your iOS listing in every App Store storefront: where the app is sold, which storefronts serve the… (1)
- [`GET /apps/{appId}/suggest`](https://storelift.net/pt/docs/api/apps/#suggest_keywords) — New keyword ideas for one app in one storefront, written in that storefront's search language: terms of… (1)
- [`POST /apps/{appId}/validate-listing`](https://storelift.net/pt/docs/api/apps/#validate_listing) — Check a draft App Store listing before it goes to App Store Connect (1)
- [`GET /apps/{appId}/draft`](https://storelift.net/pt/docs/api/apps/#draft_listing) — A listing draft — title, subtitle, promotional text and description — built from the keywords measured for… (1)
- [`GET /apps/{appId}/localize`](https://storelift.net/pt/docs/api/apps/#localize_listing) — Write the full App Store listing for a new locale — name, subtitle, keyword field and description — from… (1)
- [`GET /apps/{appId}/shot-text`](https://storelift.net/pt/docs/api/apps/#get_screenshot_text) — The caption text on your first four App Store screenshots in one storefront (1)
- [`GET /apps/{appId}/chart-movers`](https://storelift.net/pt/docs/api/apps/#get_chart_movers) — Who moved in the app's own category chart: risers and fallers (3+ places), new entrants and drop-outs,… (1)
- [`GET /apps/{appId}/featuring`](https://storelift.net/pt/docs/api/apps/#get_featuring) — Where Apple shows the app today, per country: editorial cards (dedicated: true when the story is about… (1)
- [`GET /apps/{appId}`](https://storelift.net/pt/docs/api/apps/#get_app) — One tracked app with its platform ids, countries, tracked keywords per country and the latest measurement… (1)
- [`GET /apps/{appId}/weekly-plan`](https://storelift.net/pt/docs/api/apps/#get_weekly_plan) — This week's listing suggestions for the app — the same list as the dashboard's "This week" card, best first (1)

## [Receita e Apple Ads](https://storelift.net/pt/docs/api/growth/)

As fontes conectadas de cada app: receita, eventos de assinatura, o funil da App Store, preços e códigos de oferta, o antes e depois de uma mudança, e campanhas, palavras-chave, termos de busca e comandos do Apple Ads. Escopos revenue:read e ads:read.

- [`GET /apps/{appId}/revenue`](https://storelift.net/pt/docs/api/growth/#get_revenue) — Revenue and downloads for one app from the sources the user connected: App Store Connect daily units per… (1)
- [`GET /apps/{appId}/subscriptions`](https://storelift.net/pt/docs/api/growth/#get_subscription_events) — Subscription event counts for one app from the RevenueCat / Adapty webhook: per day and per country —… (1)
- [`GET /apps/{appId}/funnel`](https://storelift.net/pt/docs/api/growth/#get_store_funnel) — The App Store conversion funnel for one app from App Store Connect analytics: impressions → product page… (1)
- [`GET /apps/{appId}/campaigns`](https://storelift.net/pt/docs/api/growth/#get_ads_campaigns) — Apple Ads campaigns that promote one app (matched by the app's App Store id, not by name): spend,… (1)
- [`GET /apps/{appId}/ads-keywords`](https://storelift.net/pt/docs/api/growth/#get_ads_keywords) — Every Apple Ads keyword bought for one app across its campaigns (last 28 days), by spend: bid, match type,… (1)
- [`GET /apps/{appId}/ads-search-terms`](https://storelift.net/pt/docs/api/growth/#get_ads_search_terms) — The searches people actually typed that triggered the app's Apple Ads (last 28 days), by spend: the search… (1)
- [`GET /apps/{appId}/ads-commands`](https://storelift.net/pt/docs/api/growth/#get_ads_command_status) — Apple Ads commands for one app's campaigns — from the dashboard, from automation rules and from… (1)
- [`GET /apps/{appId}/search-popularity`](https://storelift.net/pt/docs/api/growth/#get_search_popularity) — Apple's own search popularity, from the Apple Ads account connected to this workspace: the most searched… (1)
- [`GET /apps/{appId}/pricing`](https://storelift.net/pt/docs/api/growth/#get_pricing_offers) — Product prices and offer codes for one app from the RevenueCat or Adapty webhook, over the last 365 days:… (1)
- [`GET /apps/{appId}/country-prices`](https://storelift.net/pt/docs/api/growth/#get_country_prices) — Country prices for one of the app's products, read from App Store Connect / Google Play (Pro): per country… (1)
- [`GET /apps/{appId}/change-impact`](https://storelift.net/pt/docs/api/growth/#get_change_impact) — What a change did: for one change day (a new version, screenshots, subtitle, keyword field, a campaign… (1)

## [Hive](https://storelift.net/pt/docs/api/hive/)

Qualquer app ou mercado que a rede do Storelift mede, quer você o acompanhe ou não. Faz parte do Hive Explorer.

- [`GET /rank-check`](https://storelift.net/pt/docs/api/hive/#check_rank) — The live rank of one of your apps for any search term in one storefront, as the store shows it right now —… (10)
- [`GET /keyword-difficulty`](https://storelift.net/pt/docs/api/hive/#get_keyword_metrics) — Demand and difficulty inputs for one App Store search term in one storefront: its demand (`demand`) and… (10)
- [`GET /hive/find`](https://storelift.net/pt/docs/api/hive/#find_apps) — Find apps across the top charts we measure: filter by category, storefront, chart (Top Grossing, Top Free,… (20)
- [`GET /hive/charts`](https://storelift.net/pt/docs/api/hive/#market_charts) — One top chart as we last measured it: the ranked app ids for a storefront, list kind and optional… (10)
- [`GET /hive/movers`](https://storelift.net/pt/docs/api/hive/#market_movers) — Who climbed, who fell, who entered and who left one top chart, against the same chart N days ago (10)
- [`GET /hive/new`](https://storelift.net/pt/docs/api/hive/#market_new_apps) — Apps seen on a top chart for the first time, newest first, with the publisher behind each one (10)
- [`GET /hive/publisher/{publisherId}`](https://storelift.net/pt/docs/api/hive/#market_publisher) — Every app of one publisher that we have seen on a chart, with the day each was first seen (10)
- [`GET /hive/resolve`](https://storelift.net/pt/docs/api/hive/#hive_search_apps) — Find any app's id: by name or developer (the top matches in that storefront, with publisher, category,… (10)
- [`GET /hive/similar/{appId}`](https://storelift.net/pt/docs/api/hive/#hive_similar_apps) — The store's own similar-apps shelf for any app (Apple's You Might Also Like, Google's Similar apps), in… (10)
- [`GET /hive/reviews/{appId}`](https://storelift.net/pt/docs/api/hive/#hive_app_reviews) — Any app's recent reviews in one storefront, newest first: stars, title, text, version and date, plus the… (10)
- [`POST /hive/keywords/{term}/metrics/measure`](https://storelift.net/pt/docs/api/hive/#hive_measure_keyword_metrics) — Start a measurement of one keyword's popularity and/or difficulty in one storefront when the stored value… (50)
- [`GET /hive/apps/{id}`](https://storelift.net/pt/docs/api/hive/#hive_app_details) — Any app's latest daily measurement (10)
- [`GET /hive/keywords/{term}/ranks`](https://storelift.net/pt/docs/api/hive/#hive_keyword_ranks) — Who ranks for a keyword, day by day (10)
- [`GET /hive/keywords/{term}/metrics`](https://storelift.net/pt/docs/api/hive/#hive_keyword_metrics) — Read a keyword's current popularity and difficulty (10)
- [`GET /hive/keywords/{term}/metrics/history`](https://storelift.net/pt/docs/api/hive/#hive_keyword_metrics_history) — Read stored keyword metric observations over time (20)
- [`GET /hive/spy/{id}`](https://storelift.net/pt/docs/api/hive/#hive_keyword_spy) — The keywords any app ranks for (200)
- [`GET /hive/estimate/{id}`](https://storelift.net/pt/docs/api/hive/#hive_estimate) — Revenue and downloads for any app (500)
- [`GET /hive/gap`](https://storelift.net/pt/docs/api/hive/#get_keyword_gap) — Keyword gap across several apps (400)
- [`GET /hive/research`](https://storelift.net/pt/docs/api/hive/#hive_keyword_research) — Keyword research from a seed term (50)
- [`GET /hive/landscape`](https://storelift.net/pt/docs/api/hive/#hive_category_landscape) — What it takes to rank in a category (10)

## [Escritas](https://storelift.net/pt/docs/api/actions/)

Toda escrita roda em dois passos: uma prévia que não muda nada e, depois, uma confirmação com o token que ela devolveu.

- [`GET /jobs/{jobId}`](https://storelift.net/pt/docs/api/actions/#get_job) — Status of a long-running job started by a confirmed action (Apple Ads command, review reply, listing… (0)
- [`POST /actions`](https://storelift.net/pt/docs/api/actions/#preview_action) — Preview a write (0)
- [`POST /actions/confirm`](https://storelift.net/pt/docs/api/actions/#confirm_action) — Apply a previewed write (por ação)