v2

latestOpenAPI 3.0.22026-07-26152434.3 KB

API Logs

Send an API Log to ReadMe

Send an API Log to ReadMe, so that you can view developer usage metrics about your API. For more information see https://docs.readme.com/main/docs/sending-api-logs.

post/request

Request body

_idstring

A uuidv4 identifier for this log. If not provided we will generate one for you. This ID can be used to view the logged request and response information at {your url}/logs/{id}.

clientIPAddressstring required

The IP Address making the request.

developmentboolean

Example request

[
  {
    "request": {
      "log": {
        "creator": {
          "name": "readmeio",
          "version": "1.2.1",
          "comment": "x64-darwin21.3.0/14.19.3"
        },
        "entries": [
          {
            "pageref": "https://api.example.com/v1/pets",
            "startedDateTime": "2020-09-09T18:54:02.797Z",
            "response": {
              "content": {
                "encoding": "base64"
              }
            }
          }
        ]
      }
    }
  }
]

Response

API log was accepted into our queue.

All 15 operations