The API log object

This object represents an API log entry of any actions performed through the API endpoints.

api_version · string · required

Lago API version used in the request.

Example:

"v1"

client · string · required

The client that made the request, as reported by its user agent.

Example:

"Lago Ruby v1.26.0"

http_method · enum<string> · required

The HTTP method of the request. Requests made with the GET method are not logged.

Available options: post, put, patch, delete

Example:

"post"

http_status · integer · required

The HTTP status Lago returned for the request.

Example:

200

logged_at · string<date-time> · required

The date when the request was logged, presented in the ISO 8601 datetime format, specifically in Coordinated Universal Time (UTC).

Example:

"2025-03-31T12:31:44Z"

request_body · object · required

The parameters of the request, keyed by their top-level name. Nested values are returned JSON-encoded.

Example:

{
  "billable_metric": "{\"name\":\"Storage\",\"code\":\"storage\"}"
}

request_origin · string · required

The base URL the request was sent to.

Example:

"https://api.getlago.com"

request_path · string · required

The path of the request.

Example:

"/api/v1/billable_metrics"

created_at · string<date-time> · required

The creation date of the API log record in the Lago application, presented in the ISO 8601 datetime format, specifically in Coordinated Universal Time (UTC).

Example:

"2022-04-29T08:59:51Z"

request_id · string<uuid> · required

Unique identifier of the API log. It is the identifier of the request.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

request_response · object | null · required

The body Lago returned for the request, keyed by its top-level name. Nested values are returned JSON-encoded. Null when the response had no body.

Example:

{
  "billable_metric": "{\"lago_id\":\"b9155544-e261-4e92-b54e-f65d7609294c\"}"
}