List captured page views

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const requestLogPage = await site.requestLog().listRequestLogEntries()

{
  "requests": [
    {
      "_id": "66f1c2a9e4b0a1b2c3d4e5f6",
      "createdAt": "2026-10-01T14:03:22.000Z",
      "url": "https://www.example.com/pricing?utm_source=newsletter&gclid=Cj0KCQ",
      "path": "/pricing",
      "query": "utm_source=newsletter&gclid=Cj0KCQ",
      "params": [
        {
          "key": "utm_source",
          "value": "newsletter",
          "group": "utm"
        },
        {
          "key": "gclid",
          "value": "Cj0KCQ",
          "group": "ads"
        }
      ],
      "paramGroups": [
        "utm",
        "ads"
      ],
      "ip": "203.0.113.7",
      "country": "US",
      "geoSource": "geoip",
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 15_0) AppleWebKit/605.1.15",
      "referrer": "https://news.example.org/issue-42",
      "visitorId": "3f2b8c1e-5d4a-4e6f-9a7b-1c2d3e4f5a6b",
      "locale": "en",
      "status": 200,
      "notFound": false
    }
  ],
  "total": 1,
  "page": 1,
  "perPage": 25,
  "totalPages": 1
}

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const requestLogPage = await site.requestLog().listRequestLogEntries()

{
  "requests": [
    {
      "_id": "66f1c2a9e4b0a1b2c3d4e5f6",
      "createdAt": "2026-10-01T14:03:22.000Z",
      "url": "https://www.example.com/pricing?utm_source=newsletter&gclid=Cj0KCQ",
      "path": "/pricing",
      "query": "utm_source=newsletter&gclid=Cj0KCQ",
      "params": [
        {
          "key": "utm_source",
          "value": "newsletter",
          "group": "utm"
        },
        {
          "key": "gclid",
          "value": "Cj0KCQ",
          "group": "ads"
        }
      ],
      "paramGroups": [
        "utm",
        "ads"
      ],
      "ip": "203.0.113.7",
      "country": "US",
      "geoSource": "geoip",
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 15_0) AppleWebKit/605.1.15",
      "referrer": "https://news.example.org/issue-42",
      "visitorId": "3f2b8c1e-5d4a-4e6f-9a7b-1c2d3e4f5a6b",
      "locale": "en",
      "status": 200,
      "notFound": false
    }
  ],
  "total": 1,
  "page": 1,
  "perPage": 25,
  "totalPages": 1
}

In your app

A controller answers a route on your app: it calls listRequestLogEntries() and returns the answer.

Add the controller

app/controllers/list_request_log_entries_controller.ts

import { inject } from '@adonisjs/core'
import { SiteClient } from '@fetchski/attract-cms-sdk'

@inject()
export default class ListRequestLogEntriesController {
  constructor(protected site: SiteClient) {}

  async handle() {
    return this.site.requestLog().listRequestLogEntries()
  }
}

Add the route

start/routes.ts

import router from '@adonisjs/core/services/router'

const ListRequestLogEntriesController = () => import('#controllers/list_request_log_entries_controller')

router.get('/request-log/requests', [ListRequestLogEntriesController])

Call it

Terminal

curl http://localhost:3333/request-log/requests

With node ace serve running, it prints its answer as JSON.

Every filter is optional and they combine.

Optional parameters

One object, e.g. listRequestLogEntries({ from }); leave out the optional fields.

Date | string | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Captured at or after this ISO 8601 date or date-time. Format: an ISO 8601 date and time.

Date | string | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Captured at or before this ISO 8601 date or date-time. Format: an ISO 8601 date and time.

string | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Only paths starting with this, e.g. /blog.

string | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Only this visitor (the fetchski_vid UUID).

string | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Only this two-letter country code, e.g. US. Matches ^[A-Za-z]{2}$.

number | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Only this HTTP status, e.g. 404. At least 100.

boolean | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Only page views that did (true) or did not (false) find a page.

string | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Only rows with a parameter in this group, e.g. ads or utm.

string | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Only rows with this query parameter (case-insensitive), e.g. gclid.

string | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. The same as key (paramKey wins when both are sent).

number | null | undefined

Optional. Leave it out and the site uses 1. Page number, from 1 (a page past the end answers the last page).

number | null | undefined

Optional. Leave it out and the site uses 25. Rows per page. 1 to 100.

Returns

A RequestLogPage. A page of captured page views. Read its properties (requestLogPage.requests): each says whether the site always sends it. The example answer is the site’s wire JSON: one key differs from the property names (_id → id).

readonly RequestLogEntry[]

Always sent. A list of RequestLogEntry.

Show RequestLogEntry

One captured page view. Without Analytics or Marketing consent the row keeps only the network (a truncated IP), no user-agent and the referrer’s origin.

string

Always sent.

Date

Always sent. Format: an ISO 8601 date and time.

string

Always sent.

string

Always sent.

string | null

Always sent, can be null. The raw query string.

readonly RequestLogParam[]

Always sent. A list of RequestLogParam. Each query parameter, when parameter classification is on.

Show RequestLogParam

string

Always sent.

string

Always sent. Empty for an ad identifier the visitor gave no Marketing consent for.

string | null

Always sent, can be null. The group a classification rule put it in.

readonly string[]

Always sent.

string | null

Always sent, can be null. The visitor’s address (truncated without consent).

string | null

Always sent, can be null. Two-letter country code.

GeoSource | null

Always sent, can be null. Where the country came from. One of header, geoip; a newer site may send others, so keep a fallback.

string | null

Always sent, can be null. Empty without consent.

string | null

Always sent, can be null. Origin + path with consent, origin only without.

string | null

Always sent, can be null. Set only with Analytics or Marketing consent.

string | null

Always sent, can be null. The page’s locale.

number

Always sent. The HTTP status the page answered.

boolean

Always sent.

number

Always sent. Every match, across all pages.

number

Always sent.

number

Always sent.

number

Always sent. At least 1.

Errors

Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below. Your exception handler turns them into your app’s own answers, once for every call (see Map SDK errors to responses); catch only what you want to react to here.

401

The API key is missing, malformed, unknown, disabled, expired or archived, or a request its signing mode requires to be signed is not.Retried first: No. Read: siteMessage, errorName, data.

403

The API key lacks the scope this route needs (the message names it) or is used from outside its allowlist; or, on a route that answers 403 to everyone it refuses, the caller may not use it.Retried first: No. Read: siteMessage, errorName, data.

404

Nothing matches the identifier, or the caller may not use this route at all (it is not advertised).Retried first: No. Read: siteMessage, errorName, data.

429

The key used up its per-minute limit. Still, after the client’s own waits and retries.Retried first: Yes: the client waits Retry-After (1 s when absent; over 60 s it gives up at once) and retries, up to retries times (2 by default). Read: retryAfter (seconds, or null), siteMessage.

5xx

The site failed (or something in front of it did). Its logs say why.Retried first: A 502, 503 or 504: yes, after 0.5 s then 1 s. A 500: no. Read: siteMessage, errorName, data.

no answer

No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Yes, after 0.5 s then 1 s. Read: reason, neverConnected.

not sent

The client refused to send it (e.g. a path segment of ..); the site never saw it.Retried first: No. Read: reason (what to change).

any other

Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).Retried first: No. Read: reason, status.

setup

sites.forSite('acme') named a slug config/attract.ts doesn’t list (with the keys in the database: no row in attract_api_keys).Retried first: No: nothing was sent. Read: message, slug.

setup

The site’s entry is wrong: a malformed baseUrl or key, a key filed under another slug, or no default site. node ace attract:check names the fix.Retried first: No: nothing was sent. Read: message (what to fix).

Behavior

Access: an API key with request-log:read, or ads:all, or admin:all, or a signed-in user holding the request-log:view permission. Other callers get 404.
Rate limit: the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with Retry-After. The client waits and retries for you; you see RateLimited only if that runs out.
Retries: a read is safe to repeat: the client retries it on no answer, a 502/503/504 and a 429.
Timeout: 15 s per attempt by default; raise timeout (milliseconds) in config/attract.ts for longer.
Paging: one page per call. To walk them all, use listRequestLogEntriesAll() (see More examples): it asks for the next page as you iterate, and stops after page totalPages.

More examples

listRequestLogEntriesAll() takes listRequestLogEntries()’s arguments except page.

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
for await (const requestLogEntry of site.requestLog().listRequestLogEntriesAll()) {
  console.log(requestLogEntry) // the next page is fetched as you iterate
}

Test it

It calls the controller above with the SDK faked: fakeAttract() puts the fake in the container for this one test, and it answers every call with a valid example, so nothing leaves your machine and no key is read. Save it as tests/unit/request_log_list_request_log_entries.spec.ts, then run your tests:

tests/unit/request_log_list_request_log_entries.spec.ts

import { test } from '@japa/runner'
import app from '@adonisjs/core/services/app'
import { fakeAttract } from '@fetchski/attract-cms-adonis/testing'
import ListRequestLogEntriesController from '#controllers/list_request_log_entries_controller'

test('requestLog.listRequestLogEntries', async () => {
  const site = fakeAttract()

  const controller = await app.container.make(ListRequestLogEntriesController)
  await controller.handle()

  site.assertCalled('requestLog.listRequestLogEntries')
})

Terminal

node ace test

Answer with your own values: fake requestLog.listRequestLogEntries with a sequence() of pages, each factories.RequestLogPage({...}), and walk listRequestLogEntriesAll().

tests/unit/request_log_list_request_log_entries_answers.spec.ts

import { test } from '@japa/runner'
import { factories, fakeAttract, sequence } from '@fetchski/attract-cms-adonis/testing'

test('requestLog.listRequestLogEntries answers your values', async ({ assert }) => {
  const site = fakeAttract({
    'requestLog.listRequestLogEntries': sequence(
      factories.RequestLogPage({ page: 1, totalPages: 2 }),
      factories.RequestLogPage({ page: 2, totalPages: 2 })
    ),
  })

  const walked: unknown[] = []
  for await (const requestLogEntry of site.requestLog().listRequestLogEntriesAll()) {
    walked.push(requestLogEntry)
  }
  assert.lengthOf(walked, 2)
})

To fake listRequestLogEntriesAll(), answer requestLog.listRequestLogEntries (the walk calls it page by page): a sequence() of answers for several pages.

List captured query parameters

site.requestLog().listRequestLogParams()

GET /request-log/requests

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const requestLogPage = await site.requestLog().listRequestLogEntries()

{
  "requests": [
    {
      "_id": "66f1c2a9e4b0a1b2c3d4e5f6",
      "createdAt": "2026-10-01T14:03:22.000Z",
      "url": "https://www.example.com/pricing?utm_source=newsletter&gclid=Cj0KCQ",
      "path": "/pricing",
      "query": "utm_source=newsletter&gclid=Cj0KCQ",
      "params": [
        {
          "key": "utm_source",
          "value": "newsletter",
          "group": "utm"
        },
        {
          "key": "gclid",
          "value": "Cj0KCQ",
          "group": "ads"
        }
      ],
      "paramGroups": [
        "utm",
        "ads"
      ],
      "ip": "203.0.113.7",
      "country": "US",
      "geoSource": "geoip",
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 15_0) AppleWebKit/605.1.15",
      "referrer": "https://news.example.org/issue-42",
      "visitorId": "3f2b8c1e-5d4a-4e6f-9a7b-1c2d3e4f5a6b",
      "locale": "en",
      "status": 200,
      "notFound": false
    }
  ],
  "total": 1,
  "page": 1,
  "perPage": 25,
  "totalPages": 1
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Behavior

More examples

Test it

List captured query parameters

GET /request-log/requests

In your app

Behavior

More examples

Test it

Related

List captured query parameters

GET /request-log/requests