Ir para o conteúdo

Trace

Recuperar uma lista de traces

Retorna todos os traces disponíveis.

Nota

Este endpoint implementa paginação, ordenação e filtros. Para saber mais, consulte Fazer solicitações paginadas e parâmetros de consulta.

Escopo requerido

Valor Descrição
open:trace:read Permite listar os traces

Parâmetros de consulta

Campo Tipo Descrição Obrigatório
code string Retorna todos os traces pelo código Não
severity string Retorna todos os traces pelo valor da gravidade Não
origin.context string Retorna todos os traces pelo valor do contexto Não
origin.resource string Retorna todos os traces pelo valor do recurso Não

Parâmetros de ordenação

Campo Descrição Obrigatório
created_at Ordernar por data de criação de um pedido. Não
sent_at Ordernar por data do envio do processamento. Não

Chamada:

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

Resposta:

{
  "meta": {
    ...
  },
  "results": [
    {
        "id": "0cbc45a4-d463-4973-ae00-201f982ca3bb",
        "code": "ABC123",
        "message": "Publicado com sucesso com o ID 123456789",
        "severity": "INFO",
        "created_at": "2022-06-15T14:25:37Z",
        "origin": {
            "context": "portfolios",
            "resource": "prices"
        }
    }
  ]
}

Códigos de retorno

Nota

Para maiores informações sobre códigos de retorno, 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

Recuperar um trace

Retorna um trace especifico.

Escopo requerido

Valor Descrição
open:trace:read Permite listar os traces

Parâmetros da URL

Campo Tipo Descrição Obrigatório
id uuid Identificação do trace Sim

Chamada:

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

Resposta:

{
  "id": "0cbc45a4-d463-4973-ae00-201f982ca3bb",
  "code": "ABC123",
  "message": "Publicado com sucesso com o ID 123456789",
  "severity": "INFO",
  "extras": {},
  "channel": {
    "id": "3f042852-3efc-4d47-97f8-f94989c7b0bc"
  },
  "reference": "https://api.magalu.com/v0/portfolios/prices/630855f0-b586-4726-9c89-741fe35356c6",
  "created_at": "2022-06-15T14:25:37Z",
  "origin": {
    "context": "portfolios",
    "resource": "prices"
  },
  "sent_at": "2022-06-15T14:25:37Z"
}

Códigos de retorno

Nota

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

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