Pular para o conteúdo
MyClinicAPI Docs
GET

/v1/audit-log/export

Exportar histórico (CSV, UTF-8 com BOM, até 10.000 linhas)

Mesmos filtros da listagem. A exportação também é registrada no histórico.

Permissão:audit:export

Autenticação

Envie o token de acesso do usuário no cabeçalho Authorization e, se ele tiver mais de uma clínica, o X-Clinic-Id. Integrações servidor a servidor usam o token de serviço com X-Clinic-Id e X-Agent-Key. Como autenticar

Authorization: Bearer <TOKEN>X-Clinic-Id: <clinic_id>

Parâmetros

Parâmetros de consulta

  • pageintegerOpcional

    Paginação numerada (tabelas): página 1-based, offset = (page − 1) × limit. Ignorado quando há cursor. Listas longas/feeds devem usar cursor. · Entre 1 e 200

  • actionstringOpcional

    Ações separadas por vírgula: login, update, create, invite, configure, delete, view, reconcile, send, record_preview, revoke_access, reverse, change_role, export, approve, reject.

  • resourcestringOpcional

    Recursos separados por vírgula: clinic, user, invitation, patient, clinical_record, task, service, professional, appointment, lead, conversation, agent, approval, automation, billing, finance, knowledge, integration, audit, security, report, fiscal.

  • levelstringOpcional

    info, medio, alto (vírgula).

  • actorKindstringOpcional

    Valores: humano, agente, sistema

  • actorIdstringOpcional

    Até 64 caracteres

  • actorNamestringOpcional

    Nome exato do autor (filtro "Usuário" da tela). · Até 128 caracteres

  • fromstringOpcional

    Formato AAAA-MM-DD

  • tostringOpcional

    Formato AAAA-MM-DD

  • qstringOpcional

    Busca em ator, detalhes, recurso e id. · Até 100 caracteres

  • formatstringOpcional

    Valores: csv · Padrão: "csv"

Cabeçalhos

  • X-Clinic-IdstringOpcional

    Clínica ativa. Obrigatório só para quem tem acesso a mais de uma clínica (ou token de serviço). Validado contra o vínculo do usuário. · Padrão (regex): ^[A-Za-z0-9._-]{1,64}$

Exemplo de requisição

Gerado do contrato. Troque os marcadores entre < > pelos seus valores.

const res = await fetch("https://myclinc.leadpoint.com.br/v1/audit-log/export", {  method: "GET",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",  },})​if (!res.ok) {  const { error } = await res.json()  throw new Error(`${error.code}: ${error.message} (${error.requestId})`)}const { data } = await res.json()

Resposta

200OK — Arquivo CSV.

Exemplo gerado do esquema da resposta; valores entre < > são ilustrativos.

Códigos de erro

Corpo no formato padrão { error: { code, message, requestId } }. Veja todos os códigos.

400

Bad Request — Requisição malformada (JSON inválido, cursor inválido ou clínica ativa não informada).

401

Unauthorized — Token ausente, inválido ou expirado.

403

Forbidden — Autenticado, mas sem permissão (perfil ou clínica).

422

Unprocessable Entity — Dados semanticamente inválidos (erros por campo em details).

429

Too Many Requests — Limite de requisições excedido (veja Retry-After).

500

Internal Server Error — Erro interno (sem detalhes expostos).

503

Service Unavailable — Banco de dados indisponível ou não configurado.

Limites

Esta operação tem limite próprio: 5 requisições / 60 s. Sobre limites

Testar no Swagger(abre em nova aba)