API Reference
SupportStatusSign UpLogin
  1. LOGS API
  2. Access

Access breakdown

get
https://api.tatum.io/v4/logs/access/breakdown

Where the window's requests went: the top 10 networks plus one "other"
total, the top status codes and methods, the top 10 client IPs (each with
its error rate and egress) plus one "other" total, every traffic source
with a trend, and p50/p90/p95 latency over
time — for the same window, source and filters as /access/chart, so a
zoom updates it. Shares are of total_requests in the same response.
Source sparklines share the KPI sparklines' grid (at most 30 points,
sources_step_ms wide); the latency series has its own of at most 60.
Accepts every filter[...] field /access/events does except event_id,
plus search. When a raw read trips its bound the response is
capped: true: total_requests and every *_other are null and the lists are empty.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params

Relative look-back window. Ignored when from/to are supplied.

date-time

Inclusive window start, ISO-8601. Use together with to for an explicit
range instead of time_range.

date-time

Exclusive window end, ISO-8601. Defaults to now when only from is given.

Free-text substring match against the request URI. Matched with
lower(uri) LIKE '%needle%', so separators (/, -, _, ., :) are
fine. Control bytes are rejected; min 3 chars, max 128.

On an aggregate endpoint a search is answered from the raw table, whose
read is bounded: past ACCESS_RAW_ROW_CAP rows scanned the response is
capped: true. The floor is not cosmetic: access_logs_v1 has no index on
uri, so a 1–2 char needle scans the owner's slice for a match that would
hit nearly every row.

filter[status_code][in]
array of int32s

Include rows where status_code (HTTP response status code) is one of the given values. Repeat the parameter to pass multiple values.

filter[status_code][in]
filter[status_code][nin]
array of int32s

Exclude rows where status_code (HTTP response status code) is none of the given values. Repeat the parameter to pass multiple values.

filter[status_code][nin]
filter[status_code][between]
array of int32s
length between 2 and 2

Include rows where status_code (HTTP response status code) falls within an inclusive numeric range (SQL BETWEEN lo AND hi). Pass the parameter exactly twice: first the lower bound, then the upper bound.

filter[status_code][between]
filter[network][in]
array of strings

Include rows where network (blockchain network (chain-qualified)) is one of the given values. Repeat the parameter to pass multiple values. Pass (empty) to match rows with no network (unattributed traffic).

filter[network][in]
filter[network][nin]
array of strings

Exclude rows where network (blockchain network (chain-qualified)) is none of the given values. Repeat the parameter to pass multiple values. Pass (empty) to match rows with no network (unattributed traffic).

filter[network][nin]
filter[chain][in]
array of strings

Include rows where chain (blockchain — the parent of network) is one of the given values. Repeat the parameter to pass multiple values. Pass (empty) to match rows with no chain (unattributed traffic).

filter[chain][in]
filter[chain][nin]
array of strings

Exclude rows where chain (blockchain — the parent of network) is none of the given values. Repeat the parameter to pass multiple values. Pass (empty) to match rows with no chain (unattributed traffic).

filter[chain][nin]
filter[method][in]
array of strings

Include rows where method (HTTP / RPC method) is one of the given values. Repeat the parameter to pass multiple values.

filter[method][in]
filter[method][nin]
array of strings

Exclude rows where method (HTTP / RPC method) is none of the given values. Repeat the parameter to pass multiple values.

filter[method][nin]
string
length ≤ 128

Include rows where method (HTTP / RPC method) contains this substring (SQL LIKE '%value%').

filter[remote_ip][in]
array of strings
length ≤ 32

Include rows where remote_ip (client IP address, IPv4 or IPv6 (IPv6 matched in canonical form)) is one of the given values. Repeat the parameter to pass multiple values.

filter[remote_ip][in]
filter[remote_ip][nin]
array of strings
length ≤ 32

Exclude rows where remote_ip (client IP address, IPv4 or IPv6 (IPv6 matched in canonical form)) is none of the given values. Repeat the parameter to pass multiple values.

filter[remote_ip][nin]
filter[source][in]
array of strings

Include rows where source (traffic source / attribution channel) is one of the given values. Repeat the parameter to pass multiple values. Pass (empty) to match rows with no source (unattributed traffic).

filter[source][in]
filter[source][nin]
array of strings

Exclude rows where source (traffic source / attribution channel) is none of the given values. Repeat the parameter to pass multiple values. Pass (empty) to match rows with no source (unattributed traffic).

filter[source][nin]
filter[req_id][in]
array of strings

Include rows where req_id (request id — NOT unique, may match unrelated requests) is one of the given values. Repeat the parameter to pass multiple values.

filter[req_id][in]
Responses

Updated 20 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 20 days ago

Did this page help you?