Sign in

v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Reporting

List Access Logs

List and search access logs for the Site

get/v1/sites/{id}/access_logs

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Query parameters

duration'30m' | '1h' | '6h' | '12h' | '24h' | '72h' | '7d' | '30d' required

Duration that the listed data is for (m = minutes, h = hours, d = days)

Example:7d
domainstring

Domain that received the request, if not provided, returns logs aggregated from all valid domains

Example:rocket.net
searchstring
Example:wp-admin/*.php

Search across RayID, IP, URI, and timestamp. All fields allow partial prefix matches. URI supports up to 2 wildcards using *. Dates should be provided in YYYY-MM-DD format. All other date formats will be 'best effort' matching

ipstring

IP address related to the request

Example:1.2.3.4
cache_status'bypass' | 'dynamic' | 'expired' | 'hit' | 'miss' | 'none' | 'stable'

Type of cache interaction

Example:hit
uristring

URI being requested

Example:/blog/the-rocket-difference-how-we-created-the-fastest-wordpress-hosting-in-the-world/
ray_idstring

Unique Request ID

Example:8b5cc1855d86842a
device_type'desktop' | 'mobile' | 'tablet'

Device Type

Example:mobile
status_codestring

HTTP Status Code of the Request

Example:200
per_pageinteger

How many results to include in each page (default = 10)

pageinteger

Page of results to include (default = 1)

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "metadata": {
    "page": 1,
    "page_size": 10,
    "total": 150
  },
  "result": [
    {
      "RayID": "8b5cc1855d86842a",
      "EdgeResponseStatus": 200,
      "ClientIP": "76c9:3911:c55f:c32c:7203:4683:0a4c:cd75",
      "ClientRequestUserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148 [FBAN/FBIOS;FBAV/471.0.0.27.107;FBBV/632147304;FBDV/iPhone15,3;FBMD/iPhone;FBSN/iOS;FBSV/17.6.1;FBSS/3;FBCR/;FBID/phone;FBLC/en_US;FBOP/80]",
      "ClientDeviceType": "mobile",
      "ClientRequestURI": "/blog/the-rocket-difference-how-we-created-the-fastest-wordpress-hosting-in-the-world/",
      "ClientRequestHost": "rocket.net",
      "CacheCacheStatus": "hit",
      "ClientCountry": "us",
      "ClientRequestReferer": "https://rocket.net",
      "ClientRequestMethod": "GET",
      "timestamp": "2024-08-19T20:05:00Z"
    }
  ]
}