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

# Schema Meta: metadados da resposta da API

> Documentação do schema Meta da API Ghosting. Conheça os metadados presentes em toda resposta da API, incluindo timestamp, versão e tempo de execução.

O schema `Meta` contém metadados técnicos presentes em toda resposta da API Ghosting, seja em requisições bem-sucedidas ou em erros. Esses campos são úteis para debugging, monitoramento de performance, versionamento de integrações e rastreamento de chamadas. Sempre que você fizer uma requisição para a API Ghosting, o objeto `meta` estará presente no mesmo nível de `data` ou `error`.

## Campos do schema Meta

<ResponseField name="timestamp" type="string (ISO 8601)" required>
  Data e hora em que a resposta foi gerada pelo servidor, no formato ISO 8601 (ex: `2026-09-06T18:00:00.000Z`). Útil para correlacionar logs e rastrear a latência de ponta a ponta.
</ResponseField>

<ResponseField name="version" type="string" required>
  Versão da API que processou a requisição. Valor atual: `"v1"`. Use este campo para garantir compatibilidade futura da sua integração.
</ResponseField>

<ResponseField name="executionTimeMs" type="number" required>
  Tempo de execução da requisição no servidor, em milissegundos. Útil para monitorar a performance da API e identificar degradações.
</ResponseField>

## Exemplo JSON: resposta de sucesso

```json theme={null}
{
  "success": true,
  "data": {
    "username": "ghosting",
    "displayName": "Ghosting Oficial",
    "status": "active"
  },
  "meta": {
    "timestamp": "2026-09-06T18:00:00.000Z",
    "version": "v1",
    "executionTimeMs": 6
  }
}
```

## Exemplo JSON: resposta de erro

```json theme={null}
{
  "success": false,
  "error": {
    "code": "USER_NOT_FOUND",
    "message": "Usuário não encontrado.",
    "status": 404
  },
  "meta": {
    "timestamp": "2026-09-06T18:00:00.000Z",
    "version": "v1",
    "executionTimeMs": 4
  }
}
```

<Tip>
  Registre o campo `executionTimeMs` em seus logs de aplicação para identificar picos de latência. Valores consistentemente altos podem indicar necessidade de cache local ou ajustes na estratégia de requisições.
</Tip>

<Info>
  O campo `version` permite que sua integração detecte mudanças de versão da API automaticamente. Recomendamos validar esse valor e alertar sua equipe caso ele mude inesperadamente.
</Info>

## Leia mais

<CardGroup cols={2}>
  <Card title="Schema User" href="/schemas/user">
    Veja o objeto principal da API onde o campo `meta` acompanha a resposta.
  </Card>

  <Card title="Status Codes" href="/api-reference/status-codes">
    Entenda os códigos de status HTTP e erros retornados pela API Ghosting.
  </Card>
</CardGroup>
