---
title: "GET /apps/{appId}/usage"
description: "Uso, quotas técnicas e limites por categoria — parâmetros, schemas e exemplos completos."
sidebar:
  hidden: true
---

**Uso, quotas técnicas e limites por categoria.** Contrato v1 · disponível em produção e homologação · operação `getAppsAppIdUsage`. [Guia funcional](/api/apps-links-ativos/) · [Índice](/api/operacoes/) · [Schemas](/referencia/) · [Testar em sandbox](/console/?operation=getAppsAppIdUsage).

## Autenticação e efeito

Permissão: `usage:read`. Sessão humana ou chave de servidor limitada ao proprietário e aos aplicativos autorizados. OAuth/MCP ainda não estão disponíveis. Uma chave de exemplo deve incluir somente esta permissão e as leituras necessárias ao seu fluxo, restrita a `app_loja`; emita-a na área autenticada de desenvolvedores.

Disponível em produção e homologação; sujeito às capacidades do app e à configuração do provedor. OAuth só será aceito após B1b. Campos desconhecidos rejeitados. Consulte os ADRs para regras semânticas além do JSON Schema.

Consulta não altera o recurso. Downloads revalidam autorização e têm prazo/estado conforme o guia.

## Parâmetros

| Nome | Local | Obrigatório | Tipo e restrições |
| --- | --- | --- | --- |
| `appId` | path | sim |  OpaqueId; {"type":"string","maxLength":500,"minLength":1,"pattern":"^[^/\\u0000-\\u001f\\u007f]+$"} |



## Corpo e semântica

Sem corpo. Envie os parâmetros na URL e os headers indicados.

Omitir campos opcionais usa o default documentado ou preserva o valor em PATCH. `null` só é aceito nos campos cujo schema permite null, com efeito de limpar/desvincular indicado no guia. Arrays enviados substituem a coleção quando o endpoint define atualização completa; não implicam merge. Identificadores/owner/app de um recurso existente não são transferidos por PATCH. Herança de templates/UTMs segue o guia, sem alterar links anteriores por cópia automática.




## cURL

`AGILINK_API_KEY` deve ficar no servidor. Os placeholders abaixo são fictícios. Preserve Idempotency-Key e payload ao repetir uma intenção após timeout.

```sh
curl --request GET 'https://api.staging.agilink.io/v1/apps/app_loja/usage' \
  --header 'Authorization: Bearer <credencial>'
```

## JavaScript / TypeScript

```js
// Node.js 22+. Defina AGILINK_API_KEY no ambiente do servidor.
const response = await fetch('https://api.staging.agilink.io/v1/apps/app_loja/usage', {
  method: 'GET',
  headers: {
  "Authorization": `Bearer ${process.env.AGILINK_API_KEY}`
},
  redirect: 'error', signal: AbortSignal.timeout(30000)
});
if (!response.ok) throw new Error('HTTP '+response.status+' requestId='+response.headers.get('X-Request-Id'));
const result = await response.json();
console.log(result);
```

## Python

```python
# Python 3.10+; pip install requests
import os
import requests
headers = {
  "Authorization": "Bearer " + os.environ["AGILINK_API_KEY"]
}
response = requests.request(
    'GET', 'https://api.staging.agilink.io/v1/apps/app_loja/usage',
    headers=headers,
    timeout=30, allow_redirects=False)
if not 200 <= response.status_code < 300:
    raise RuntimeError(f'HTTP {response.status_code}; requestId={response.headers.get("X-Request-Id")}')
result = response.json()
print(result)
```

## Response 200

Sucesso. Exemplo fictício.

| Header | Significado | Exemplo |
| --- | --- | --- |
| `X-Request-Id` | Identificador gerado pelo servidor, inclusive para falhas e replays. | conforme resposta |
| `Cache-Control` | Respostas administrativas não podem ser armazenadas. | no-store, no-transform |
| `ETag` | Revisão forte, a enviar em If-Match na alteração. | "20000000-0000-4000-8000-000000000001" |

```json
{
  "data": {
    "appId": "app_loja",
    "scope": "credential",
    "windowSeconds": 60,
    "limits": {
      "ingress": 1200,
      "read": 600,
      "write": 120
    },
    "usage": {
      "read": 1
    },
    "sharedLimits": {
      "owner": {
        "ingress": 2400,
        "read": 1200,
        "write": 240
      },
      "app": {
        "ingress": 1200,
        "read": 600,
        "write": 120
      }
    },
    "sharedUsage": {
      "owner": {
        "read": 1
      },
      "app": {
        "read": 1
      }
    }
  },
  "meta": {
    "requestId": "req_00000000000040008000000000000001"
  }
}
```

| Campo | Tipo | Obrigatório | Significado e limites |
| --- | --- | --- | --- |
| `data` | object | sim | Resultado tipado da operação.  |
| `data.appId` | string | sim | Aplicativo proprietário; precisa estar autorizado. Até 500 caracteres; Formato validado pelo schema |
| `data.scope` | objeto | sim | Valor tipado; formato e restrições completos no schema abaixo.  |
| `data.windowSeconds` | objeto | sim | Valor tipado; formato e restrições completos no schema abaixo.  |
| `data.limits` | object | sim | Valor tipado; formato e restrições completos no schema abaixo.  |
| `data.limits.ingress` | integer | sim | Valor tipado; formato e restrições completos no schema abaixo.  |
| `data.limits.read` | integer | sim | Valor tipado; formato e restrições completos no schema abaixo.  |
| `data.limits.write` | integer | sim | Valor tipado; formato e restrições completos no schema abaixo.  |
| `data.usage` | object | sim | Valor tipado; formato e restrições completos no schema abaixo.  |
| `data.sharedLimits` | object | sim | Valor tipado; formato e restrições completos no schema abaixo.  |
| `data.sharedLimits.owner` | object | sim | Valor tipado; formato e restrições completos no schema abaixo.  |
| `data.sharedLimits.app` | object | sim | Valor tipado; formato e restrições completos no schema abaixo.  |
| `data.sharedUsage` | object | sim | Valor tipado; formato e restrições completos no schema abaixo.  |
| `data.sharedUsage.owner` | object | sim | Valor tipado; formato e restrições completos no schema abaixo.  |
| `data.sharedUsage.app` | object | sim | Valor tipado; formato e restrições completos no schema abaixo.  |
| `meta` | object | sim | Correlação e informações da resposta.  |
| `meta.requestId` | RequestId | sim | Identificador de correlação gerado pelo servidor.  |

## Falhas, revisão e repetição

Respeite Retry-After quando existir. Leituras podem ser repetidas após falhas transitórias. Não faça retry automático ilimitado.

| Status | Significado |
| --- | --- |
| 400 | Cabeçalho, query, cursor ou JSON inválido. |
| 401 | Credencial inválida, expirada ou revogada. |
| 403 | Operação sem permissão ou capacidade desabilitada. |
| 404 | Recurso inexistente ou fora dos aplicativos autorizados. |
| 422 | JSON bem formado com dados de domínio inválidos. |
| 429 | Quota excedida. Respeitar Retry-After. |
| 500 | Falha interna. Use requestId para diagnóstico. |
| 503 | Dependência indisponível; resultado da mutação pode ser incerto. |

### Exemplo 401

```json
{
  "error": {
    "code": "unauthenticated",
    "message": "Credencial inválida, expirada ou revogada.",
    "requestId": "req_00000000000040008000000000000001",
    "documentationUrl": "https://docs.agilink.io/api/errors/#unauthenticated"
  }
}
```

### Exemplo 403

```json
{
  "error": {
    "code": "insufficient_permission",
    "message": "Operação sem permissão ou capacidade desabilitada.",
    "requestId": "req_00000000000040008000000000000001",
    "documentationUrl": "https://docs.agilink.io/api/errors/#insufficient-permission"
  }
}
```

### Exemplo 429

```json
{
  "error": {
    "code": "rate_limited",
    "message": "Quota excedida. Respeitar Retry-After.",
    "requestId": "req_00000000000040008000000000000001",
    "documentationUrl": "https://docs.agilink.io/api/errors/#rate-limited"
  }
}
```

## Schema completo e próximos passos

<details><summary>Schema de request</summary>

```json
{
  "description": "Sem corpo"
}
```

</details>

<details><summary>Schema de response</summary>

```json
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "appId": {
          "type": "string",
          "maxLength": 500,
          "minLength": 1,
          "pattern": "^[^/\\u0000-\\u001f\\u007f]+$"
        },
        "scope": {
          "const": "credential"
        },
        "windowSeconds": {
          "const": 60
        },
        "limits": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "ingress": {
              "type": "integer"
            },
            "read": {
              "type": "integer"
            },
            "write": {
              "type": "integer"
            }
          },
          "required": [
            "ingress",
            "read",
            "write"
          ]
        },
        "usage": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "minimum": 0
          }
        },
        "sharedLimits": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "owner": {
              "type": "object",
              "additionalProperties": {
                "type": "integer",
                "minimum": 1
              }
            },
            "app": {
              "type": "object",
              "additionalProperties": {
                "type": "integer",
                "minimum": 1
              }
            }
          },
          "required": [
            "owner",
            "app"
          ]
        },
        "sharedUsage": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "owner": {
              "type": "object",
              "additionalProperties": {
                "type": "integer",
                "minimum": 0
              }
            },
            "app": {
              "type": "object",
              "additionalProperties": {
                "type": "integer",
                "minimum": 0
              }
            }
          },
          "required": [
            "owner",
            "app"
          ]
        }
      },
      "required": [
        "appId",
        "scope",
        "windowSeconds",
        "limits",
        "usage",
        "sharedLimits",
        "sharedUsage"
      ]
    },
    "meta": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "requestId": {
          "$ref": "#/components/schemas/RequestId"
        }
      },
      "required": [
        "requestId"
      ]
    }
  },
  "required": [
    "data",
    "meta"
  ]
}
```

</details>

[Convenções e limites](/api/contratos/) · [Erros](/api/errors/) · [Receitas completas](/receitas/) · [Guia funcional](/api/apps-links-ativos/).