Histórico

O histórico de mensagens é um recurso disponibilizado para que seja possível acompanhar o processamento das mensagens dentro da fila, trazendo informações úteis para o usuário final, como de êxito ou falha de um processamento, facilitando a atuação em cima de eventuais problemas.

Consultar histórico

Para consultar o histórico.

Nota

Este endpoint implementa paginação, ordenação e filtros. Em Parâmetros de ordenação é especificado os campos disponíveis para fazê-la. Para saber mais, consulte Fazer solicitações paginadas e parâmetros de consulta.

Escopo requerido

Valor	Descrição
open:queue-history:read	Permite listar o histórico

Parâmetros de consulta

Campo	Tipo	Descrição	Obrigatório
type	string	Filtra o histórico apenas pelo tipo.	Não
id	uuid4	Filtra o histórico apenas por meio do id de notificação.	Não
request_id	uuid4	Filtra o histórico apenas por meio do id de requisição.	Não
created_at	date	Filtra o histórico pela data de criação.	Não

Parâmetros de ordenação

Campo	Descrição	Obrigatório
id	Orderna o histórico apenas por meio do id.	Não
created_at	Ordena o histórico pela data de criação.	Não

Chamada:

curl -X 'GET' \
  'https://api.magalu.com/v0/queues/history' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <Access Token>' \
  -H 'Content-Type: application/json' \

Resposta:

{
  "meta": {
    ...
  },
  "results": [
    {
        "id": "e74c7524-0843-4e65-8838-2f89fbfdd11e",
        "type": "xpto",
        "body": {"foo": "bar"},
        "status_code": 200,
        "request_id": "2265be17-40f2-4d7d-8ffd-8f4c0d6fcdbe",
        "created_at": "2022-06-15T14:25:37Z"
    }
  ]
}

Códigos de retorno

Nota

Para maiores informações sobre códigos de retorno, consulte Código de retorno.

Código	Descrição
200	Ok
400	Bad Request
401	Unauthorized
403	Forbidden
422	Unprocessable Entity
500	Internal Server Error
502	Bad Gateway
503	Service Unavailable
504	Gateway Timeout