Aktivite API

Aktivite modülünün tüm işlemleri (2) ve veri modelleri (2): adresler, izinler, girdiler, ön koşullar, olaylar ve örnekler.

Çalışma alanınızda olan her şeyin canlı akışı.

Modül kodu activity · 2 işlem · 2 veri modeli · 2 olay. Bir anahtar ya da token, arkasındaki kişinin bu modülde yapabildiğinden fazlasını asla yapamaz; satır düzeyindeki güvenlik uygulamadakiyle birebir aynıdır. Yetki kapsamları: activity (hepsi), activity:read (yalnız okuma) ya da activity:<yetenek>.

Kaynaklar

KaynakTabloListeleme ve okumaPOSTPATCHDELETE
activitiesactivity/api/v1/activities
eventsevent/api/v1/events

Listeler limit (en çok 200), cursor, order (ör. -created_at), fields ve q alır; diğer her sorgu parametresi bir sütun süzgecidir: ?status=paid, ?total[gte]=100, ?id[in]=a,b, ?x=null.

İşlemler

İşlemGereken izinNe yapar
activity.purgeactivity:manageEtkinlik saklama kuralını uygula
activity.sealactivity:manageDenetim kaydını mühürle

activity.purge

Etkinlik saklama kuralını uygula — Çalışma alanının saklama süresinden eski etkinlikleri siler. 0 her şeyi saklar.

Gereken izin activity:manage · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

POSThttps://app.getera.io/api/v1/activities/actions/purge
API anahtarı ya da OAuth token · activity:manage
  • Asıl adres: POST /api/v1/actions/activity.purge

Girdi

AlanTürZorunluAçıklama
daysnumberSakla (gün)

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

KodNe zaman reddedilir
retention_too_shortSaklama süresi 0 (her şeyi sakla) ya da en az 30 gün olmalı.

Yayımladığı olaylar: activity.purged

Neye yazar: activity (delete) — Removes rows older than the window

curl -X POST https://app.getera.io/api/v1/activities/actions/purge \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"days":1}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "activity.purged"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.activities.purge({
  days: 1
})
era activities purge \
  --days 1
tools/call
{
  "name": "era__activity__purge",
  "arguments": {
    "days": 1
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde activity:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 retention_too_short · 429 çok sık istek

activity.seal

Denetim kaydını mühürle — Kesinleşmiş her etkinlik satırını bir öncekine zincirler; sonradan yapılan değişiklik fark edilir.

Gereken izin activity:manage · veriyi değiştirir

POSThttps://app.getera.io/api/v1/activities/actions/seal
API anahtarı ya da OAuth token · activity:manage
  • Asıl adres: POST /api/v1/actions/activity.seal

Girdi

Bu işlem girdi almaz.

Yayımladığı olaylar: activity.sealed

Neye yazar: activity (update) — Writes prev_hash and row_hash on unsealed rows

curl -X POST https://app.getera.io/api/v1/activities/actions/seal \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'
Yanıt
{
  "ok": true,
  "result": "…",
  "events": [
    "activity.sealed"
  ]
}
import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.activities.seal()
era activities seal
tools/call
{
  "name": "era__activity__seal",
  "arguments": {}
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde activity:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 429 çok sık istek

Veri modelleri

Activity

Tablo activity · Kaynak activities

  • GET /api/v1/activities
  • GET /api/v1/activities/{id}
SütunTürBoş olabilirİzin verilen değerlerBağlı olduğu tablo
idstring (int64) · int8
organization_idstring (uuid) · uuidorganization
workspace_idstring (uuid) · uuidworkspace
actor_typestring · text
actor_idstring (uuid) · uuidevet
actor_labelstring · textevet
module_codestring · text
record_typestring · textevet
record_idstring (uuid) · uuidevet
verbstring · text
summarystring · text
diffobject · jsonbevet
sourcestring · text
occurred_atstring (date-time) · timestamptz
reasonstring · textevet
correlation_idstring (uuid) · uuidevet
run_idstring · textevet
job_idstring · textevet
source_ipstring · textevet
user_agentstring · textevet
sealed_atstring (date-time) · timestamptzevet

Birincil anahtar: id

Event

Tablo event · Kaynak events

  • GET /api/v1/events
  • GET /api/v1/events/{id}
SütunTürBoş olabilirİzin verilen değerlerBağlı olduğu tablo
idstring (int64) · int8
organization_idstring (uuid) · uuidorganization
workspace_idstring (uuid) · uuidworkspace
namestring · text
module_codestring · text
record_idstring (uuid) · uuidevet
payloadobject · jsonb
sourcestring · text
occurred_atstring (date-time) · timestamptz
dispatched_atstring (date-time) · timestamptzevet
attemptsinteger · int4
last_errorstring · textevet
next_attempt_atstring (date-time) · timestamptzevet
correlation_idstring (uuid) · uuidevet

Birincil anahtar: id

Olaylar

İş akışları ve webhook'lar bu olaylara tepki verir.

OlayNe olurTaşıdığı alanlar
activity.purgedSaklama süresini aşan etkinlik silindi.days, removed
activity.sealedKesinleşen etkinlik satırları denetim mührüne zincirlendi.sealed
Bu sayfa yardımcı oldu mu?