Pular para o conteúdo principal
GET
/
audit-logs
Listar eventos de log de auditoria
curl --request GET \
  --url https://api.altostrat.io/audit-logs \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "log_id": "log_2zqrA8B3C4d5E6f7g8h9I0jKlMn",
      "organization_id": "org_xWl6uERh4pBpJxhA",
      "workspace_id": "ws_sz4e50hmqKgjxwiYsK",
      "user_id": "auth0|9b6efd7459f548c8bb542fe81568791f",
      "name": "Jane Doe",
      "email": "jane.doe@altostrat.io",
      "session_id": "sess_a1b2c3d4e5f6a7b8",
      "event_time": "2025-10-29T12:26:01.123Z",
      "method": "PUT",
      "endpoint": "/api/v1/projects/proj_A7Bkj29s/settings",
      "status_code": 200,
      "status_code_type": "2xx",
      "ip_address": "188.45.21.109",
      "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36",
      "frontend_page": "/projects/proj_A7Bkj29s/settings/general",
      "request_payload": {
        "name": "Meu Incrível Projeto Atualizado",
        "visibility": "private"
      },
      "response_payload": {
        "status": "success",
        "message": "Configurações do projeto atualizadas com sucesso."
      },
      "request_id": "req_abc123xyz789-test-01",
      "ttl": 1766862361
    }
  ],
  "pagination": {
    "count": 25,
    "limit": 25,
    "cursor": "eyJQSyI6eyJTIjoiT1JH...In0sInNrIjp7IlMiOiJMT0cj...In19",
    "has_more": true
  },
  "filters": {
    "start_date": "2025-10-01",
    "http_verb": "PUT",
    "limit": 25
  },
  "query_info": {
    "scanned_count": 150,
    "query_time_seconds": 0.082
  },
  "warnings": [
    "Os resultados podem estar incompletos ao usar `search_term` devido a limitações da consulta. Use filtros indexados e mais específicos para resultados abrangentes."
  ],
  "context": {
    "requesting_user_id": "auth0|5a4b3c2d1e0f9g8h7i6j5k4l",
    "requesting_workspace_id": "ws_abc123def456ghi789",
    "organization_id": "org_xWl6uERh4pBpJxhA",
    "timestamp": "2025-10-29T14:05:12.345Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
start_date
string<date>

A data de início para o intervalo da consulta, inclusiva. Formato: AAAA-MM-DD.

Example:

"2025-10-01"

​
end_date
string<date>

A data de término para o intervalo da consulta, inclusiva. Deve ser igual ou posterior à start_date. Formato: AAAA-MM-DD.

Example:

"2025-10-31"

​
user_id
string

Filtra eventos para um usuário específico pelo seu identificador único.

Example:

"auth0|9b6efd7459f548c8bb542fe81568791f"

​
workspace_id
string

Filtra eventos para um workspace específico pelo seu identificador único.

Example:

"ws_sz4e50hmqKgjxwiYsK"

​
http_verb
string

Filtra por método HTTP (ex: POST, DELETE). Para excluir um método, prefixe-o com um ponto de exclamação (ex: !GET).

Example:

"POST"

​
status_code
integer

Filtra por um código de status HTTP específico.

Required range: 100 <= x <= 599
Example:

404

​
endpoint
string

Filtra pelo caminho do endpoint da API. Esta é uma busca por prefixo (ex: /api/v1/users corresponderá a /api/v1/users/usr_123).

Example:

"/api/v1/projects"

​
search_term
string

Um termo de busca de texto livre. A busca será realizada em campos como endpoint, nome de usuário, e-mail, endereço IP e payloads de requisição/resposta. Nota: O uso de search_term pode ser menos performático do que filtros indexados.

Example:

"falha no login do usuário"

​
ip_address
string<ipv4>

Filtra eventos originados de um endereço IP específico.

Example:

"198.51.100.14"

​
cursor
string

Uma string opaca que identifica o ponto de partida para a próxima página de resultados. Obtenha este valor do campo pagination.cursor de uma resposta anterior.

Example:

"eyJQSyI6eyJTIjoiT1JH...In0sInNrIjp7IlMiOiJMT0cj...In19"

​
limit
integer
default:25

Um limite para o número de objetos a serem retornados, entre 1 e 100. O padrão é 25.

Required range: 1 <= x <= 100
Example:

50

​
sort_order
enum<string>
default:desc

A ordem na qual os resultados devem ser classificados. desc para os mais recentes primeiro, asc para os mais antigos primeiro.

Opções disponíveis:
asc,
desc
Example:

"desc"

Response

Uma lista paginada de eventos de log de auditoria que correspondem à consulta.

​
data
object[]
​
pagination
object
​
filters
object

Os filtros que foram aplicados a esta consulta.

Example:
{
  "start_date": "2025-10-01",
  "http_verb": "PUT",
  "limit": 25
}
​
query_info
object

Metadados sobre a execução da consulta.

​
warnings
string[]

Uma lista de avisos sobre a consulta, como ao usar filtros potencialmente incompletos.

Example:
[
  "Os resultados podem estar incompletos ao usar `search_term` devido a limitações da consulta. Use filtros indexados e mais específicos para resultados abrangentes."
]
​
context
object

Informações contextuais sobre a própria requisição da API.