Logs: Retrieve All

This documentation entry provides a comprehensive guide to using the "Retrieve All" logs endpoint, including all relevant details about the request, response, and data structures.

Endpoint

GET /api/logs/

Retrieve a list of all logs associated with your account.

Request

HTTP Request

GET https://uptimekeep.com/api/logs/

Headers

Header	Type	Description
Authorization	String	Bearer token for API authentication.

Query Parameters

Parameter	Type	Description	Default Value
page	Integer	(Optional) The page number to retrieve.	1
results_per_page	Integer	(Optional) Number of results per page. Allowed values: 10, 25, 50, 100, 250, 500, 1000.	25

Example of a request:

curl --request GET \
--url 'https://uptimekeep.com/api/logs/' \
--header 'Authorization: Bearer {api_key}'

Response

A successful response returns a JSON object with the list of logs and associated metadata.

Response Example

{
    "data": [
        {
            "type": "login.success",
            "ip": "127.0.0.1",
            "device_type": "mobile",
            "continent_code": "EU",
            "country_code": "IT",
            "city_name": "Rome",
            "datetime": "2021-02-03 12:21:40"
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://uptimekeep.com/api/logs?&page=1",
        "last": "https://uptimekeep.com/api/logs?&page=1",
        "next": null,
        "prev": null,
        "self": "https://uptimekeep.com/api/logs?&page=1"
    }
}

Fields

Data Object

Field	Type	Description
type	String	Type of log event (e.g., "login.success").
ip	String	IP address from which the event originated.
device_type	String	Type of device used (e.g., "mobile", "desktop").
continent_code	String	Continent code where the event occurred (e.g., "EU").
country_code	String	Country code where the event occurred (e.g., "IT").
city_name	String	City name where the event occurred (e.g., "Rome").
datetime	String	Date and time of the event (in YYYY-MM-DD HH:MM:SS format).

Meta Object

Field	Type	Description
page	Integer	Current page number of the results.
results_per_page	Integer	Number of results per page.
total	Integer	Total number of logs.
total_pages	Integer	Total number of pages available based on the current query.

Links Object

Field	Type	Description
first	String	URL of the first page of results.
last	String	URL of the last page of results.
next	String	URL of the next page of results (if applicable).
prev	String	URL of the previous page of results (if applicable).
self	String	URL of the current page of results.

Errors

If the request fails, the API will return an error message with an appropriate HTTP status code.