> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter métricas do banco de dados

> Obter as métricas do seu banco de dados hospedado.

<ParamField header="Authorization" type="string" placeholder="Chave da API" required>
  A chave da API para sua conta. Você pode encontrá-la nas [configurações da conta](https://squarecloud.app/pt-br/account/security).
</ParamField>

### Parâmetros

<ParamField path="database_id" type="string" placeholder="ID do banco de dados" required>
  O ID do banco de dados.
</ParamField>

### Resposta

<ResponseField name="status" type="string">
  Indica se a chamada foi bem-sucedida. `success` se bem-sucedida, `error` se não.
</ResponseField>

<ResponseField name="response" type="array">
  O conteúdo da resposta.

  <Expandable title="Alternar objeto">
    <ResponseField name="date" type="string">
      A data em formato ISO.
    </ResponseField>

    <ResponseField name="cpu" type="number">
      A porcentagem atual de uso da CPU.
    </ResponseField>

    <ResponseField name="ram" type="number">
      O uso atual de RAM em MB.
    </ResponseField>

    <ResponseField name="net" type="int[]">
      Um array representando o total de rede usado. Primeiro é entrada (input), segundo é saída (output).
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json theme={null}
  {
      "status": "success",
      "response": [
          {
              "date": "2025-08-13T12:55:01.348Z",
              "cpu": 0.45,
              "ram": 111.27,
              "net": [
                  16834,
                  126
              ]
          },
          {
              "date": "2025-08-13T12:50:01.349Z",
              "cpu": 0.45,
              "ram": 111.22,
              "net": [
                  16834,
                  126
              ]
          },
          {
              "date": "2025-08-13T12:45:01.350Z",
              "cpu": 0.58,
              "ram": 111.36,
              "net": [
                  16834,
                  126
              ]
          },
          {
              "date": "2025-08-13T12:40:01.348Z",
              "cpu": 0.43,
              "ram": 118.44,
              "net": [
                  16834,
                  126
              ]
          }
      ]
  }
  ```
</ResponseExample>