PocketBase logo PocketBase v0.19.4
FAQ Discussions Support us Documentation
Introduction Collections API rules and filters Client-side SDKs Authentication Files upload and handling Working with relations Use as framework Web APIs reference ├ API Records ├ API Realtime ├ API Files ├ API Admins ├ API Collections ├ API Settings ├ API Logs ├ API Backups └ API Health Going to production
Extend with
Go
Extend with
JavaScript
Go Overview Go Event hooks Go Routing Go Database Go Record operations Go Collection operations Go Migrations Go Jobs scheduling Go Console commands Go Sending emails Go Rendering templates Go Testing Go Custom models
JS Overview JS Event hooks JS Routing JS Database JS Record operations JS Collection operations JS Migrations JS Jobs scheduling JS Console commands JS Sending emails JS Sending HTTP requests JS Rendering templates JS Types reference
Web APIs reference - API Logs

Returns a paginated request logs list.

Only admins can access this action.

import PocketBase from 'pocketbase'; const pb = new PocketBase('http://127.0.0.1:8090'); ... await pb.admins.authWithPassword('test@example.com', '1234567890'); const pageResult = await pb.logs.getRequestsList(1, 20, { filter: 'status >= 400', sort: '-created' });
import 'package:pocketbase/pocketbase.dart'; final pb = PocketBase('http://127.0.0.1:8090'); ... await pb.admins.authWithPassword('test@example.com', '1234567890'); final pageResult = await pb.logs.getRequestsList( page: 1, perPage: 20, filter: 'status >= 400', sort: '-created' );
GET
/api/logs/requests
Requires Authorization: TOKEN
Query parameters
Param Type Description
page Number The page (aka. offset) of the paginated list (default to 1).
perPage Number The max returned request logs per page (default to 30).
sort String

Specify the ORDER BY fields.

Add - / + (default) in front of the attribute for DESC / ASC order, eg.:

// DESC by the insertion rowid and ASC by status ?sort=-rowid,status

Supported request log sort fields:
@random, rowid, id, created, updated, url, method, status, auth, remoteIp, userIp, referer, userAgent

filter String

Filter expression to filter/search the returned request logs list, eg.:

?filter=(url~'test.com' && created>'2022-01-01')

Supported request log filter fields:
rowid, id, created, updated, url, method, status, auth, userIp, remoteIp, referer, userAgent

The syntax basically follows the format OPERAND OPERATOR OPERAND, where:

  • OPERAND - could be any of the above field literal, string (single or double quoted), number, null, true, false
  • OPERATOR - is one of:
    • = Equal
    • != NOT equal
    • > Greater than
    • >= Greater than or equal
    • < Less than
    • <= Less than or equal
    • ~ Like/Contains (if not specified auto wraps the right string OPERAND in a "%" for wildcard match)
    • !~ NOT Like/Contains (if not specified auto wraps the right string OPERAND in a "%" for wildcard match)
    • ?= Any/At least one of Equal
    • ?!= Any/At least one of NOT equal
    • ?> Any/At least one of Greater than
    • ?>= Any/At least one of Greater than or equal
    • ?< Any/At least one of Less than
    • ?<= Any/At least one of Less than or equal
    • ?~ Any/At least one of Like/Contains (if not specified auto wraps the right string OPERAND in a "%" for wildcard match)
    • ?!~ Any/At least one of NOT Like/Contains (if not specified auto wraps the right string OPERAND in a "%" for wildcard match)

To group and combine several expressions you could use parenthesis (...), && (AND) and || (OR) tokens.

fields String

Comma separated string of the fields to return in the JSON response (by default returns all fields). Ex.:

?fields=*,expand.relField.name

* targets all keys from the specific depth level.

In addition, the following field modifiers are also supported:

  • :excerpt(maxLength, withEllipsis?)
    Returns a short plain text version of the field string value.
    Ex.: ?fields=*,description:excerpt(200,true)
Responses
{ "page": 1, "perPage": 20, "totalItems": 3, "items": [ { "id": "ox0A8SjBXcdoZC0", "created": "2022-06-01 13:11:23.302Z", "updated": "2022-06-01 13:11:23.302Z", "url": "/api/users/auth-methods", "method": "get", "status": 200, "auth": "guest", "ip": "127.0.0.1:48272", "referer": "http://127.0.0.1:8090/", "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "meta": {} }, { "id": "elLzrW94D54Hxhj", "created": "2022-06-01 13:10:03.374Z", "updated": "2022-06-01 13:10:03.374Z", "url": "/api/users/auth-methods", "method": "get", "status": 200, "auth": "guest", "remoteIp": "127.0.0.1:56134", "userIp": "127.0.0.1:56134", "referer": "http://127.0.0.1:8090/", "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "meta": {} }, { "id": "WEiJHGnOnjS3see", "created": "2022-06-01 13:09:43.429Z", "updated": "2022-06-01 13:09:43.429Z", "url": "/api/users/auth-methods", "method": "get", "status": 200, "auth": "guest", "remoteIp": "127.0.0.1:56134", "userIp": "127.0.0.1:56134", "referer": "http://127.0.0.1:8090/", "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "meta": {} } ] }
{ "code": 400, "message": "Something went wrong while processing your request. Invalid filter.", "data": {} }
{ "code": 401, "message": "The request requires admin authorization token to be set.", "data": {} }
{ "code": 403, "message": "You are not allowed to perform this request.", "data": {} }

Returns a single request log by its ID.

Only admins can access this action.

import PocketBase from 'pocketbase'; const pb = new PocketBase('http://127.0.0.1:8090'); ... await pb.admins.authWithEmail('test@example.com', '123456'); const log = await pb.logs.getRequest('REQUEST_ID');
import 'package:pocketbase/pocketbase.dart'; final pb = PocketBase('http://127.0.0.1:8090'); ... await pb.admins.authWithEmail('test@example.com', '123456'); final log = await pb.logs.getRequest('REQUEST_ID');
GET
/api/logs/requests/id
Requires Authorization: TOKEN
Path parameters
Param Type Description
id String ID of the Request log to view.
Query parameters
Param Type Description
fields String

Comma separated string of the fields to return in the JSON response (by default returns all fields). Ex.:

?fields=*,expand.relField.name

* targets all keys from the specific depth level.

In addition, the following field modifiers are also supported:

  • :excerpt(maxLength, withEllipsis?)
    Returns a short plain text version of the field string value.
    Ex.: ?fields=*,description:excerpt(200,true)
Responses
{ "id": "WEiJHGnOnjS3see", "created": "2022-06-01 13:09:43.429Z", "updated": "2022-06-01 13:09:43.429Z", "url": "/api/collections/users/auth-methods", "method": "get", "status": 200, "auth": "guest", "remoteIp": "127.0.0.1:56134", "userIp": "127.0.0.1:56134", "referer": "http://127.0.0.1:8090/", "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36", "meta": {} }
{ "code": 401, "message": "The request requires admin authorization token to be set.", "data": {} }
{ "code": 403, "message": "You are not allowed to perform this request.", "data": {} }
{ "code": 404, "message": "The requested resource wasn't found.", "data": {} }

Returns hourly aggregated request logs statistics.

Only admins can access this action.

import PocketBase from 'pocketbase'; const pb = new PocketBase('http://127.0.0.1:8090'); ... await pb.admins.authWithPassword('test@example.com', '123456'); const stats = await pb.logs.getRequestsStats({ filter: 'status >= 400' });
import 'package:pocketbase/pocketbase.dart'; final pb = PocketBase('http://127.0.0.1:8090'); ... await pb.admins.authWithPassword('test@example.com', '123456'); final stats = await pb.logs.getRequestsStats( filter: 'status >= 400' );
GET
/api/logs/requests/stats
Requires Authorization: TOKEN
Query parameters
Param Type Description
filter String

Filter expression to filter/search the request logs, eg.:

?filter=(url~'test.com' && created>'2022-01-01')

Supported request log filter fields:
rowid, id, created, updated, url, method, status, auth, ip, referer, userAgent

The syntax basically follows the format OPERAND OPERATOR OPERAND, where:

  • OPERAND - could be any of the above field literal, string (single or double quoted), number, null, true, false
  • OPERATOR - is one of:
    • = Equal
    • != NOT equal
    • > Greater than
    • >= Greater than or equal
    • < Less than
    • <= Less than or equal
    • ~ Like/Contains (if not specified auto wraps the right string OPERAND in a "%" for wildcard match)
    • !~ NOT Like/Contains (if not specified auto wraps the right string OPERAND in a "%" for wildcard match)
    • ?= Any/At least one of Equal
    • ?!= Any/At least one of NOT equal
    • ?> Any/At least one of Greater than
    • ?>= Any/At least one of Greater than or equal
    • ?< Any/At least one of Less than
    • ?<= Any/At least one of Less than or equal
    • ?~ Any/At least one of Like/Contains (if not specified auto wraps the right string OPERAND in a "%" for wildcard match)
    • ?!~ Any/At least one of NOT Like/Contains (if not specified auto wraps the right string OPERAND in a "%" for wildcard match)

To group and combine several expressions you could use parenthesis (...), && (AND) and || (OR) tokens.

fields String

Comma separated string of the fields to return in the JSON response (by default returns all fields). Ex.:

?fields=*,expand.relField.name

* targets all keys from the specific depth level.

In addition, the following field modifiers are also supported:

  • :excerpt(maxLength, withEllipsis?)
    Returns a short plain text version of the field string value.
    Ex.: ?fields=*,description:excerpt(200,true)
Responses
[ { "total": 4, "date": "2022-06-01 19:00:00.000" }, { "total": 1, "date": "2022-06-02 12:00:00.000" }, { "total": 8, "date": "2022-06-02 13:00:00.000" } ]
{ "code": 400, "message": "Something went wrong while processing your request. Invalid filter.", "data": {} }
{ "code": 401, "message": "The request requires admin authorization token to be set.", "data": {} }
{ "code": 403, "message": "You are not allowed to perform this request.", "data": {} }
FAQ Discussions Support us
Documentation JavaScript SDK Dart SDK
PocketBase
© 2023 PocketBase The Gopher artwork is from marcusolsson/gophers
Crafted by Gani