---
title: "GetAuditSessionSummary"
description: "Summarize one agent session"
canonical: "https://pgbeam.com/docs/go-sdk/agents/getAuditSessionSummary"
last-updated: "2026-09-13T16:16:22.000Z"
---

# GetAuditSessionSummary

> Summarize one agent session

URL: https://pgbeam.com/docs/go-sdk/agents/getAuditSessionSummary

Groups a session's audit entries into one deterministic summary: the credentials and origins involved, the window it spans, how many statements were allowed, blocked, masked and truncated, the rows and bytes it moved, and the tables it read, wrote and was refused. No model is involved, so the same entries always summarize the same way. Returns metadata only (table names and counts), never row values, and requires the same audit:read permission the list and export endpoints do.

## Usage

## Parameters

Parameter

Type

Required

Description

ctx

`context.Context`

Yes

Request context

projectID

`string`

Yes

Unique project identifier (prefixed, e.g. prj\_xxx).

sessionID

`string`

Yes

Session identifier from an audit entry's session\_id field. Unique per connection within a proxy instance, not over time.

params

`*pgbeam.GetAuditSessionSummaryParams`

No

Query parameters

params.Start

`string`

No

Return entries at or after this timestamp (inclusive lower bound).

params.End

`string`

No

Return entries strictly older than this timestamp (cursor / upper bound).

## Response

`(*pgbeam.AuditSessionSummary, error)`: session summary.

## Example

## Errors

Status

Description

400

The request was rejected. `code` is `INVALID_INPUT`, and `errors` names the offending fields when the failure was a validation one.

401

Missing or invalid authentication. `code` is `UNAUTHORIZED`.

403

The caller is authenticated but not allowed to perform this operation. `code` is `FORBIDDEN` when the caller's role is insufficient, and `PLAN_LIMIT_REACHED` when the organization's plan is what stands in the way. The two are answered differently, so branch on the code rather than the status.

404

The resource does not exist, or the caller is not entitled to know that it does. `code` is `NOT_FOUND`.

429

Rate limited. `code` is `RATE_LIMITED`.

500

The request failed for a reason on our side. `code` is `INTERNAL_ERROR`. Quote `request_id` when reporting it.