Logs (API) | JsonLog API 文件

Log submission and retrieval

GET/log

Returns ephemeral in-memory logs for real-time debugging. Without auth returns public logs. With auth and cid returns channel logs. More LogEntry Guide

Responses

200application/json

Array of log entries

schemaarray

itemLogEntryrequired

evtobjectrequired

tsnumberrequired

iatnumberrequired

expnumberrequired

regstringrequired

lvlanyOf

Variant

Option 1number

Option 2string

svcstring

hoststring

appstring

pidanyOf

Variant

Option 1number

Option 2string

reqstring

accstring

Account identifier.

uidstring

User identifier.

sidstring

Session identifier.

cidstring

Channel identifier.

ipstring

httpnumber

envstring

imgstring

txidstring

altstring

trcstring

spnstring

404

Channel not found

curl -X GET \\
  "${BASE_URL}/log?cid=string" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/log?cid=string";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/log?cid=string";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/log?cid=string",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/log?cid=string",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/log?cid=string", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/log?cid=string", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/log?cid=string", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/log?cid=string", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/log?cid=string")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/log?cid=string", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/log?cid=string");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/log

Logs are persisted to SSTable files, broadcast to WebSocket subscribers, and stored briefly in-memory. Use cid parameter for channel-specific logs. More LogEntry Guide

Body application/json

_jsonlogobject

evtobject

tsnumber

iatnumber

expnumber

regstring

lvlanyOf

Variant

Option 1number

Option 2string

svcstring

hoststring

appstring

pidanyOf

Variant

Option 1number

Option 2string

reqstring

accstring

Account identifier.

uidstring

User identifier.

sidstring

Session identifier.

cidstring

Channel identifier.

ipstring

httpnumber

envstring

imgstring

txidstring

altstring

trcstring

spnstring

Responses

200

Log stored successfully

401

Authentication required for this channel

404

Channel not found

curl -X POST \\
  "${BASE_URL}/log?cid=string" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"_jsonlog":{"evt":{},"ts":123,"iat":123,"exp":123,"reg":"string","lvl":"value","svc":"string","host":"string","app":"string","pid":"value","req":"string","acc":"string","uid":"string","sid":"string","cid":"string","ip":"string","http":123,"env":"string","img":"string","txid":"string","alt":"string","trc":"string","spn":"string"}}'

const payload = {"_jsonlog":{"evt":{},"ts":123,"iat":123,"exp":123,"reg":"string","lvl":"value","svc":"string","host":"string","app":"string","pid":"value","req":"string","acc":"string","uid":"string","sid":"string","cid":"string","ip":"string","http":123,"env":"string","img":"string","txid":"string","alt":"string","trc":"string","spn":"string"}};
const url = "${BASE_URL}/log?cid=string";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"_jsonlog":{"evt":{},"ts":123,"iat":123,"exp":123,"reg":"string","lvl":"value","svc":"string","host":"string","app":"string","pid":"value","req":"string","acc":"string","uid":"string","sid":"string","cid":"string","ip":"string","http":123,"env":"string","img":"string","txid":"string","alt":"string","trc":"string","spn":"string"}};
const url = "${BASE_URL}/log?cid=string";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"_jsonlog":{"evt":{},"ts":123,"iat":123,"exp":123,"reg":"string","lvl":"value","svc":"string","host":"string","app":"string","pid":"value","req":"string","acc":"string","uid":"string","sid":"string","cid":"string","ip":"string","http":123,"env":"string","img":"string","txid":"string","alt":"string","trc":"string","spn":"string"}};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/log?cid=string",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"_jsonlog":{"evt":{},"ts":123,"iat":123,"exp":123,"reg":"string","lvl":"value","svc":"string","host":"string","app":"string","pid":"value","req":"string","acc":"string","uid":"string","sid":"string","cid":"string","ip":"string","http":123,"env":"string","img":"string","txid":"string","alt":"string","trc":"string","spn":"string"}};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/log?cid=string",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"_jsonlog":{"evt":{},"ts":123,"iat":123,"exp":123,"reg":"string","lvl":"value","svc":"string","host":"string","app":"string","pid":"value","req":"string","acc":"string","uid":"string","sid":"string","cid":"string","ip":"string","http":123,"env":"string","img":"string","txid":"string","alt":"string","trc":"string","spn":"string"}};
const { body } = await request("${BASE_URL}/log?cid=string", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"_jsonlog":{"evt":{},"ts":123,"iat":123,"exp":123,"reg":"string","lvl":"value","svc":"string","host":"string","app":"string","pid":"value","req":"string","acc":"string","uid":"string","sid":"string","cid":"string","ip":"string","http":123,"env":"string","img":"string","txid":"string","alt":"string","trc":"string","spn":"string"}}
response = requests.request( \
    "POST", \
    "${BASE_URL}/log?cid=string", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"_jsonlog":{"evt":{},"ts":123,"iat":123,"exp":123,"reg":"string","lvl":"value","svc":"string","host":"string","app":"string","pid":"value","req":"string","acc":"string","uid":"string","sid":"string","cid":"string","ip":"string","http":123,"env":"string","img":"string","txid":"string","alt":"string","trc":"string","spn":"string"}}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/log?cid=string", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"_jsonlog":{"evt":{},"ts":123,"iat":123,"exp":123,"reg":"string","lvl":"value","svc":"string","host":"string","app":"string","pid":"value","req":"string","acc":"string","uid":"string","sid":"string","cid":"string","ip":"string","http":123,"env":"string","img":"string","txid":"string","alt":"string","trc":"string","spn":"string"}}`))

req, err := http.NewRequest("POST", "${BASE_URL}/log?cid=string", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"_jsonlog":{"evt":{},"ts":123,"iat":123,"exp":123,"reg":"string","lvl":"value","svc":"string","host":"string","app":"string","pid":"value","req":"string","acc":"string","uid":"string","sid":"string","cid":"string","ip":"string","http":123,"env":"string","img":"string","txid":"string","alt":"string","trc":"string","spn":"string"}}
uri = URI("${BASE_URL}/log?cid=string")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"_jsonlog":{"evt":{},"ts":123,"iat":123,"exp":123,"reg":"string","lvl":"value","svc":"string","host":"string","app":"string","pid":"value","req":"string","acc":"string","uid":"string","sid":"string","cid":"string","ip":"string","http":123,"env":"string","img":"string","txid":"string","alt":"string","trc":"string","spn":"string"}};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/log?cid=string", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/log?cid=string");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"_jsonlog\":{\"evt\":{},\"ts\":123,\"iat\":123,\"exp\":123,\"reg\":\"string\",\"lvl\":\"value\",\"svc\":\"string\",\"host\":\"string\",\"app\":\"string\",\"pid\":\"value\",\"req\":\"string\",\"acc\":\"string\",\"uid\":\"string\",\"sid\":\"string\",\"cid\":\"string\",\"ip\":\"string\",\"http\":123,\"env\":\"string\",\"img\":\"string\",\"txid\":\"string\",\"alt\":\"string\",\"trc\":\"string\",\"spn\":\"string\"}}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

LogEntry

evtobjectrequired

tsnumberrequired

iatnumberrequired

expnumberrequired

regstringrequired

lvlanyOf

Variant

Option 1number

Option 2string

svcstring

hoststring

appstring

pidanyOf

Variant

Option 1number

Option 2string

reqstring

accstring

Account identifier.

uidstring

User identifier.

sidstring

Session identifier.

cidstring

Channel identifier.

ipstring

httpnumber

envstring

imgstring

txidstring

altstring

trcstring

spnstring

Features

日誌擷取

Types

LogEntry

Logs

Contents

Retrieve in-memory logs

Submit a log entry

Models

Features

Types

Contents

Retrieve in-memory logs

Submit a log entry

Models

Related Features and Types

Features

Types