NOnotefile
route

GET /v1/projects/{projectOrProductUID}/routes/{routeUID}/route-logs

Changed on

Get Route Logs by Route UID

Request

  • Base URL
    https://api.notefile.net
  • URL
    https://api.notefile.net/v1/projects/{projectOrProductUID}/routes/{routeUID}/route-logs
  • Auth
    HTTP bearer

Path parameters

projectOrProductUIDstring required
routeUIDstring required

Query parameters

pageSizeinteger
pageNuminteger
deviceUIDstring[]

A Device UID.

sortBy'date' | 'event'
sortOrder'asc' | 'desc'
startDateinteger

Start date for filtering results, specified as a Unix timestamp

endDateinteger

End date for filtering results, specified as a Unix timestamp

systemFilesOnlyboolean
mostRecentOnlyboolean
filesstring
routingStatusstring[]
responseStatusstring[]

Response

Successful operation

attnboolean

If true, an error was returned when routing

datestring

The date of the logs.

durationinteger

The duration of the route in milliseconds

event_uidstring

The event UID.

route_uidstring

The route UID.

statusstring

The status of the event.

textstring

The response body of the route.

urlstring

The URL of the route.

Changes

  • 1f4693048cb8Revision changes
    • breaking

      for the query request parameter pageNum, the format changed from no format to int32

    • breaking

      for the query request parameter pageSize, the format changed from no format to int32

  • 1887e880199aRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status