Fetch messages from a log.

{
  "type": "object",
  "properties": {
    "messages": {
      "type": "array",
      "description": "Log messages.",
      "items": {
        "type": "object",
        "properties": {
          "application": {
            "type": "string",
            "description": "Used to identify which application logged this message. You can use this if you have multiple applications and services logging to the same log"
          },
          "breadcrumbs": {
            "type": "array",
            "description": "A list of breadcrumbs preceding this log message.",
            "items": {
              "type": "object",
              "description": "A breadcrumb represent a step preceding a log message.",
              "properties": {
                "action": {
                  "type": "string",
                  "description": "An action representing the breadcrumb. You can set a custom action or use one of the built-in: click, submit, navigation, request, error."
                },
                "dateTime": {
                  "type": "string",
                  "format": "date-time",
                  "description": "The date and time in UTC of the breadcrumb. If no date and time is provided, we will use the current date and time in UTC."
                },
                "message": {
                  "type": "string",
                  "description": "A message representing the breadcrumb. This should elaborate on the action."
                },
                "severity": {
                  "type": "string",
                  "description": "An enum value representing the severity of this breadcrumb. The following values are allowed: Verbose, Debug, Information, Warning, Error, Fatal."
                }
              }
            }
          },
          "category": {
            "type": "string",
            "description": "The log message category. Category can be a string of choice but typically contain a logging category set by a logging framework like NLog or Serilog."
          },
          "code": {
            "type": "string",
            "description": "Code can be used to include source code related to the log message. The code will typically span from a few lines before the line causing the log message\r\nto a few lines after. For now, all lines above 21 will be removed. This makes room for showing 10 lines before the logging line, the logging line, and\r\n10 lines after the logging line. Don't include a very large string in this property since that will quickly make the entire messages exceed the max limit\r\nof 256 kb."
          },
          "cookies": {
            "type": "array",
            "description": "A key/value pair of cookies. This property only makes sense for logging messages related to web requests.",
            "items": {
              "type": "object",
              "description": "Represents a key value pair.",
              "properties": {
                "key": {
                  "type": "string",
                  "description": "The key of the item."
                },
                "value": {
                  "type": "string",
                  "description": "The value of the item."
                }
              }
            }
          },
          "correlationId": {
            "type": "string",
            "description": "CorrelationId can be used to group similar log messages together into a single discoverable batch. A correlation ID could be a session ID from ASP.NET Core,\r\na unique string spanning multiple microsservices handling the same request, or similar."
          },
          "data": {
            "type": "array",
            "description": "A key/value pair of user-defined fields and their values. When logging an exception, the Data dictionary of\r\nthe exception is copied to this property. You can add additional key/value pairs, by modifying the Data\r\ndictionary on the exception or by supplying additional key/values to this API.",
            "items": {
              "type": "object",
              "description": "Represents a key value pair.",
              "properties": {
                "key": {
                  "type": "string",
                  "description": "The key of the item."
                },
                "value": {
                  "type": "string",
                  "description": "The value of the item."
                }
              }
            }
          },
          "dateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time in UTC of the message. If you don't provide us with a value in dateTime, we will set the current date and time in UTC."
          },
          "detail": {
            "type": "string",
            "description": "A longer description of the message. For errors this could be a stacktrace, but it's really up to you what to log in there."
          },
          "form": {
            "type": "array",
            "description": "A key/value pair of form fields and their values. This property makes sense if logging message related to users inputting data in a form.",
            "items": {
              "type": "object",
              "description": "Represents a key value pair.",
              "properties": {
                "key": {
                  "type": "string",
                  "description": "The key of the item."
                },
                "value": {
                  "type": "string",
                  "description": "The value of the item."
                }
              }
            }
          },
          "hostname": {
            "type": "string",
            "description": "The hostname of the server logging the message."
          },
          "id": {
            "type": "string",
            "description": "The ID of this message."
          },
          "method": {
            "type": "string",
            "description": "If message relates to a HTTP request, you may send the HTTP method of that request. If you don't provide us with a method, we will try to find a key named REQUEST_METHOD in serverVariables."
          },
          "queryString": {
            "type": "array",
            "description": "A key/value pair of query string parameters. This property makes sense if logging message related to a HTTP request.",
            "items": {
              "type": "object",
              "description": "Represents a key value pair.",
              "properties": {
                "key": {
                  "type": "string",
                  "description": "The key of the item."
                },
                "value": {
                  "type": "string",
                  "description": "The value of the item."
                }
              }
            }
          },
          "serverVariables": {
            "type": "array",
            "description": "A key/value pair of server values. Server variables are typically related to handling requests in a webserver but could be used for other types of information as well.",
            "items": {
              "type": "object",
              "description": "Represents a key value pair.",
              "properties": {
                "key": {
                  "type": "string",
                  "description": "The key of the item."
                },
                "value": {
                  "type": "string",
                  "description": "The value of the item."
                }
              }
            }
          },
          "severity": {
            "type": "string",
            "description": "An enum value representing the severity of this message. The following values are allowed: Verbose, Debug, Information, Warning, Error, Fatal"
          },
          "source": {
            "type": "string",
            "description": "The source of the code logging the message. This could be the assembly name."
          },
          "statusCode": {
            "type": "integer",
            "format": "int32",
            "description": "If the message logged relates to a HTTP status code, you can put the code in this property. This would probably only be relevant for errors,\r\nbut could be used for logging successful status codes as well."
          },
          "title": {
            "type": "string",
            "description": "The textual title or headline of the message to log."
          },
          "titleTemplate": {
            "type": "string",
            "description": "The title template of the message to log. This property can be used from logging frameworks that supports\r\nstructured logging like: \"{user} says {quote}\". In the example, titleTemplate will be this string and title\r\nwill be \"Gilfoyle says It's not magic. It's talent and sweat\"."
          },
          "type": {
            "type": "string",
            "description": "The type of message. If logging an error, the type of the exception would go into type but you can put anything in there, that makes sense for your domain."
          },
          "url": {
            "type": "string",
            "description": "If message relates to a HTTP request, you may send the URL of that request. If you don't provide us with an URL, we will try to find a key named URL in serverVariables."
          },
          "user": {
            "type": "string",
            "description": "An identification of the user triggering this message. You can put the users email address or your user key into this property."
          },
          "version": {
            "type": "string",
            "description": "Versions can be used to distinguish messages from different versions of your software. The value of version can be a SemVer compliant string or any other\r\nsyntax that you are using as your version numbering scheme."
          }
        }
      }
    },
    "total": {
      "type": "integer",
      "format": "int32",
      "description": "The total number of log messages found."
    }
  }
}