Filtros disponíveis
Você pode utilizar query parameters para filtrar os relatórios retornados por este endpoint.Parâmetros suportados
| Parâmetro | Tipo | Descrição |
|---|---|---|
take | number | Limita o número de relatórios retornados (ex: take=10) |
skip | number | Ignora os primeiros N resultados (ex: skip=5) |
statusValue | string | Filtra por status do relatório: approved, rejected, pending |
document | string | CPF ou CNPJ do cliente associado ao relatório (somente números) |
Exemplo de requisição com filtros
GET /report/list?take=2&document=24657266000170
Você pode combinar múltiplos filtros conforme necessário.
curl --location 'https://gyra-core.gyramais.com.br/report/list?take=2&document=24657266000170' \
--header 'Authorization: Bearer {seu_token_jwt}'
fetch("https://gyra-core.gyramais.com.br/report/list?take=2&document=24657266000170", {
headers: {
Authorization: "Bearer {seu_token_jwt}"
}
})
.then(res => res.json())
.then(console.log)
import requests
headers = {
"Authorization": "Bearer {seu_token_jwt}"
}
params = {
"take": 2,
"document": "24657266000170"
}
response = requests.get("https://gyra-core.gyramais.com.br/report/list", headers=headers, params=params)
print(response.json())
O exemplo de resposta foi resumido para facilitar a leitura. O JSON completo está disponível no ambiente real ou mediante solicitação técnica.
[
{
"id": "6612a7f3fe1b3b8900000000",
"policyId": "6612a7f3625ea4ab00000000",
"policyVersion": 1.11,
"policyName": "Completo+",
"policyStatus": "DENIED",
"policyErrorStatusApplied": null,
"name": "EMPRESA EXEMPLO LTDA",
"score": 1,
"document": "43591367000130",
"userId": "6612a7f338154f0100000000",
"analystId": null,
"analystName": null,
"customerId": "6612a7f33920d25b00000000",
"committeeStatus": null,
"committeeDecision": null,
"committeeAt": null,
"createdAt": "2026-07-31T17:47:43.007Z",
"commentary": null,
"yearMonthDay": 20260731,
"previousAnalystId": null,
"previousAnalystName": null,
"verified": true,
"exportUrl": "https://exemplo.gyramais.com.br/arquivo",
"exportExcelUrl": null,
"parecerEnabled": true,
"previousStatus": null,
"status": {
"id": "6612a7f3410dcd8100000000",
"title": "Não iniciado",
"value": "PENDING",
"color": "#FBBB3B"
},
"reportProgress": {
"isFinalized": true,
"finalizedAt": "2026-07-31T17:50:11.585Z",
"executedAt": "2026-07-31T17:47:43.007Z",
"elapsedTimeMs": 148578,
"totalIntegrations": [
"..."
],
"processedIntegrations": [
"..."
]
}
},
{
"id": "6612a7f3f404c4c500000000",
"policyId": "6612a7f3625ea4ab00000000",
"policyVersion": 1.11,
"policyName": "Completo+",
"policyStatus": "DENIED",
"policyErrorStatusApplied": null,
"name": "EMPRESA EXEMPLO LTDA",
"score": 500,
"document": "43591367000130",
"userId": "6612a7f338154f0100000000",
"analystId": null,
"analystName": null,
"customerId": "6612a7f33a4a151300000000",
"committeeStatus": null,
"committeeDecision": null,
"committeeAt": null,
"createdAt": "2026-07-31T17:47:29.772Z",
"commentary": null,
"yearMonthDay": 20260731,
"previousAnalystId": null,
"previousAnalystName": null,
"verified": true,
"exportUrl": "https://exemplo.gyramais.com.br/arquivo",
"exportExcelUrl": null,
"parecerEnabled": true,
"previousStatus": null,
"status": {
"id": "6612a7f3410dcd8100000000",
"title": "Não iniciado",
"value": "PENDING",
"color": "#FBBB3B"
},
"reportProgress": {
"isFinalized": true,
"finalizedAt": "2026-07-31T17:49:47.337Z",
"executedAt": "2026-07-31T17:47:29.772Z",
"elapsedTimeMs": 137565,
"totalIntegrations": [
"..."
],
"processedIntegrations": [
"..."
]
}
}
]
{
"code": 401,
"message": "Token de acesso inválido."
}
Quando usar
Use este endpoint para recuperar histórico de análises com filtros operacionais. Você pode usar em telas de acompanhamento, filas de trabalho de analistas ou consultas por documento/status/período para operação diária.Autenticação
Bearer JWT no headerAuthorization.