Saltar para o conteúdo
Verificado

Ler e resumir os seus registos

Obtenha uma janela de registos de pedidos e depois a mesma janela como contagens agrupadas, para uma página de estado ou uma resposta de suporte.

get_logs lê de volta os mesmos documentos account_log que cada chamada a /cpi escreve por si, limitados à sua própria conta: o que foi chamado, de onde e o que regressou. get_logs_counts responde a uma pergunta mais estreita sobre a mesma janela, quantos, agrupados, o que é mais barato do que percorrer todas as linhas quando uma resposta de suporte ou um widget de estado só precisa da forma de um período, não do seu detalhe.

Métodos

POST/cpi/get_logs
user

Get Logs

Queries logs of a given type within a timestamp range, with optional search, paging, and status filters.

POST/cpi/get_logs_counts
user

Get Logs Counts

Returns grouped log counts by request type or response status within a timestamp range.

Passo a passo

Leia uma janela de entradas

log_type, log_date_from e log_date_to são os únicos campos declarados, mas o handler lê também um log_search não declarado (texto livre sobre os corpos e cabeçalhos do pedido/resposta) e log_status ('success' ou 'failed', por faixa de estado HTTP). log_type: "account_log" limita automaticamente a esta conta, nunca passa uid você mesmo.

curl -s https://xuda.ai/cpi/get_logs \
  -H 'content-type: application/json' \
  -d '{
    "api_key": "YOUR_API_KEY",
    "log_type": "account_log",
    "log_date_from": 1735689600000,
    "log_date_to": 1738368000000,
    "log_status": "failed"
  }'
const res = await fetch('https://xuda.ai/cpi/get_logs', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    api_key: 'YOUR_API_KEY',
    log_type: 'account_log',
    log_date_from: Date.UTC(2025, 0, 1),
    log_date_to: Date.UTC(2025, 1, 1),
    log_status: 'failed',
  }),
});
const { code, data } = await res.json();
if (code > 0) for (const row of data.docs) console.log(row.method, row.response_status_code);
import requests

res = requests.post(
    'https://xuda.ai/cpi/get_logs',
    json={
        'api_key': 'YOUR_API_KEY',
        'log_type': 'account_log',
        'log_date_from': 1735689600000,
        'log_date_to': 1738368000000,
        'log_status': 'failed',
    },
)
body = res.json()
if body['code'] > 0:
    for row in body['data']['docs']:
        print(row['method'], row['response_status_code'])

2. Obtenha a mesma janela como contagens agrupadas

get_logs_counts também precisa de um valor não declarado request_type ou response_status para escolher que vista agrupada lê; não enviar nenhum é uma recusa, não um resultado vazio (ver Erros). request_type é o próprio campo request_type do registo, 'POST' para todas as linhas account_log que add_account_log escreve atualmente. A chave de agrupamento com que response_status é construído vive numa definição de vista que este repositório não inclui, confirme primeiro com get_logs os valores sob os quais as suas próprias linhas se agrupam em vez de adivinhar um.

curl -s https://xuda.ai/cpi/get_logs_counts \
  -H 'content-type: application/json' \
  -d '{
    "api_key": "YOUR_API_KEY",
    "log_type": "account_log",
    "log_date_from": 1735689600000,
    "log_date_to": 1738368000000,
    "request_type": "POST"
  }'
const res = await fetch('https://xuda.ai/cpi/get_logs_counts', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    api_key: 'YOUR_API_KEY',
    log_type: 'account_log',
    log_date_from: Date.UTC(2025, 0, 1),
    log_date_to: Date.UTC(2025, 1, 1),
    request_type: 'POST',
  }),
});
const { code, data } = await res.json();
import requests

res = requests.post(
    'https://xuda.ai/cpi/get_logs_counts',
    json={
        'api_key': 'YOUR_API_KEY',
        'log_type': 'account_log',
        'log_date_from': 1735689600000,
        'log_date_to': 1738368000000,
        'request_type': 'POST',
    },
)
body = res.json()

A resposta

get_logs passa diretamente um resultado find do Mango, docs mais um bookmark para a página seguinte:

json
{
  "code": 1,
  "data": {
    "docs": [
      {
        "_id": "log_9c21ff",
        "docType": "account_log",
        "ts": 1737042311422,
        "method": "create_contact",
        "source": "api",
        "channel": "api",
        "api_pk": "pk_7f2a...",
        "req_body": { "name": "Priya Shah", "email": "[email protected]" },
        "response_status_code": 200,
        "response_data": "{\"contact_id\":\"cnt_a91f0e\"}",
        "user_email": "[email protected]",
        "date_created": 1737042311422
      }
    ],
    "bookmark": "g1AAAABweJzLYWBg..."
  }
}

get_logs_counts passa em vez disso um resultado bruto de vista agrupada do CouchDB, rows de { key, value } em que value é a contagem dessa chave. Os campos que compõem key são definidos pela própria vista, não por este handler; trate-o como um id de grupo opaco e leia value para obter o número.

Erros

A seguir