Skip to content

Logs

Endpoints for monitoring the processing and logging of requests.

Operations

Get Logs

Request

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

Security
API-Key
Query
clientCodestring
modulestring
Enum:"ANA""COL""EST""GIS""SIL""TRA"
endpointstring
startDateTimestring, (date-time)
endDateTimestring, (date-time)
cursorstring
hasErrorboolean
logStatusstring
Enum:"Completed""Pending"
dataReadyboolean
packagestring
Enum:"Analytics""Telemetry"
curl -i -X GET \
  'https://api-alliances.inflor-qas.cloud/api/v2/logs?clientCode=string&module=ANA&endpoint=string&startDateTime=2019-08-24T14%3A15%3A22Z&endDateTime=2019-08-24T14%3A15%3A22Z&cursor=string&hasError=true&logStatus=Completed&dataReady=true&package=Analytics' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success.

Bodyapplication/json
requestIdstring or null
statusstring

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"
Example:"success"
messagestring
dadosobject
errorsobject or 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
{
  "requestId": "string",
  "status": "success",
  "message": "string",
  "dados": {
    "items": [ … ],
    "pagination": { … }
  },
  "errors": {
    "property1": [ … ],
    "property2": [ … ]
  }
}