ReferenceAPI ReferenceAudit Logs
List Audit Logs
List Audit Logs.
Request
interface AuditLogsListRequest {
action: 'get'
resource: '/audit-logs'
details?: {
limit: number | undefined
offset: number | undefined
sort_by: 'created_at' | undefined
sort: 'asc' | 'desc' | undefined
} | undefined
}Prop
Type
Response
interface AuditLogsListResponse_success {
status: 'success'
error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
message?: string | undefined
details: {
id: string
customer_id: string
entity_type: string
entity_id: string
action: string
actor_id: string | null | undefined
created_at: string
action_details: unknown
} []
metadata: {
total_count: number
}
}Prop
Type
Example
import { resourceSchema } from '@blockstream/ecs-js-sdk'
import { broadcastRequest } from './broadcaster'
const response = await broadcastRequest<
typeof resourceSchema.shape.audit-logs.shape.list
>(
{
action: 'get',
resource: '/audit-logs',
details: {
// TODO: fill in required fields
},
},
blockstream,
)