# Get Logs

Searches for the logs of the requests made by your account.

Endpoint: GET /logs
Version: v2
Security: API-Key

## Security:

  - `API-Key` (unknown)
    apiKey in header Authorization

## Query parameters:

  - `clientCode` (string)

  - `module` (string)

  - `endpoint` (string)

  - `startDateTime` (string)

  - `endDateTime` (string)

  - `cursor` (string)

  - `hasError` (boolean)

  - `logStatus` (string)

  - `dataReady` (boolean)

  - `package` (string)

## Response 200:

  - `200` (unknown)
    Success.

## Response 200 fields (application/json):

  - `requestId` (string | null)

  - `status` (string)
    Request outcome. Open list: new values may be added; clients should tolerate unknown values.
    Enum: "success", "processing", "accepted", "bad_request", "unprocessable_entity", "error", "service_unavailable"

  - `message` (string)

  - `dados` (object)

  - `dados.items` (array)

  - `dados.items.clientName` (string)

  - `dados.items.requestId` (string)

  - `dados.items.responseId` (string | null)

  - `dados.items.resource` (string)

  - `dados.items.requestAt` (string)

  - `dados.items.responseAt` (string)

  - `dados.items.module` (string)
    Enum: "ANA", "COL", "EST", "GIS", "SIL", "TRA"

  - `dados.items.errorMessage` (string | null)

  - `dados.items.logStatus` (string)
    Enum: "Completed", "Pending"

  - `dados.items.dataReady` (boolean)

  - `dados.pagination` (object)

  - `dados.pagination.count` (integer)

  - `dados.pagination.pageSize` (integer)

  - `dados.pagination.hasNextPage` (boolean)

  - `dados.pagination.nextCursor` (string | null)

  - `dados.pagination.previousCursor` (string | null)

  - `dados.pagination.orderBy` (array)

  - `dados.pagination.orderBy.columnName` (string)

  - `dados.pagination.orderBy.direction` (string)

  - `errors` (object | null)
    Validation or rejection errors, per field (field -> list of messages). The `$` key identifies a rejection not tied to a specific field. It is null on technical failures.

## Response 202:

  - `202` (unknown)
    Your request is being processed.

## Response 202 fields (application/json):

  - `requestId` (string | null)

  - `status` (string)
    Request outcome. Open list: new values may be added; clients should tolerate unknown values.
    Enum: "success", "processing", "accepted", "bad_request", "unprocessable_entity", "error", "service_unavailable"

  - `message` (string)

  - `dados` (object | array | null)

  - `errors` (object | null)
    Validation or rejection errors, per field (field -> list of messages). The `$` key identifies a rejection not tied to a specific field. It is null on technical failures.

## Response 400 fields (application/json):

  - `requestId` (string | null)

  - `status` (string)
    Request outcome. Open list: new values may be added; clients should tolerate unknown values.
    Enum: "success", "processing", "accepted", "bad_request", "unprocessable_entity", "error", "service_unavailable"

  - `message` (string)

  - `dados` (object | array | null)

  - `errors` (object | null)
    Validation or rejection errors, per field (field -> list of messages). The `$` key identifies a rejection not tied to a specific field. It is null on technical failures.

## Response 500 fields (application/json):

  - `requestId` (string | null)

  - `status` (string)
    Request outcome. Open list: new values may be added; clients should tolerate unknown values.
    Enum: "success", "processing", "accepted", "bad_request", "unprocessable_entity", "error", "service_unavailable"

  - `message` (string)

  - `dados` (object | array | null)

  - `errors` (object | null)
    Validation or rejection errors, per field (field -> list of messages). The `$` key identifies a rejection not tied to a specific field. It is null on technical failures.