List branch log field values

get

https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}/logs/fields/{field_name}/values

Lists the distinct values observed for a low-cardinality log field in
the requested time range. Call the log fields endpoint first to learn
which field_name values this branch supports; a field that branch has
never emitted is rejected with unknown_field.

Give the window either as since or as an explicit start_time;
supplying both is rejected. If neither is given, the previous six hours
are used. The maximum supported time range is seven days.

Note: This endpoint is currently in Private Beta.

Path Params

project_id

string

required

^[a-z0-9-]{1,60}$

The Neon project ID

branch_id

string

required

^[a-z0-9-]{1,60}$

The Neon branch ID

field_name

string

required

length ≥ 1

The log field whose distinct values should be returned. Must be one of
the names returned by the log fields endpoint for this branch.

Query Params

since

string

^[0-9]{1,6}(ms|s|m|h|d)$

Length of the lookup window, ending at end_time or at the current
time when end_time is omitted. Mutually exclusive with
start_time. Defaults to six hours.

start_time

date-time

Inclusive beginning of the lookup window. Mutually exclusive with
since.

end_time

date-time

Exclusive end of the lookup window. Defaults to the current time.

source

string

enum

Only consider records emitted by this Neon service.

Allowed:

limit

integer

1 to 1000

Defaults to 100

Maximum number of distinct values to return. The response sets
is_truncated when this bound, or the server's own scan cap, cut the
list short.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Distinct values for the requested log field

400The lookup could not be served as written. The body is always ProjectBranchLogsInvalidQuery — see reason for the exact cause.

404Logs are not available for this branch, or the project/branch was not found. The body is always ProjectBranchLogsNotAvailable — see reason for the exact cause.