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

timestamp · 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.

version · 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.

executionTimeMs · number · required

Tempo de execução da requisição no servidor, em milissegundos. Útil para monitorar a performance da API e identificar degradações.

Exemplo JSON: resposta de sucesso

{
  "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

{
  "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
  }
}

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.

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.

Leia mais

Schema User

Veja o objeto principal da API onde o campo meta acompanha a resposta.

Status Codes

Entenda os códigos de status HTTP e erros retornados pela API Ghosting.