/projects/{project_id}/branches/{branch_id}/logs/fields/{field_name}/valuesbetaList branch log field 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.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/logs/fields/$FIELD_NAME/values" \
-H "Authorization: Bearer $NEON_API_KEY"Every field below is optional. An empty body works too.
import { createNeonClient, raw } from '@neon/sdk';
const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.listProjectBranchLogFieldValues({
client: neon.client,
path: {
project_id: process.env.PROJECT_ID,
branch_id: process.env.BRANCH_ID,
field_name: process.env.FIELD_NAME
},
query: {
since: "1h"
}
});Parameters
project_idThe Neon project ID
branch_idThe Neon branch ID
field_nameThe log field whose distinct values should be returned. Must be one of the names returned by the log fields endpoint for this branch.
sinceLength 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_timeInclusive beginning of the lookup window. Mutually exclusive with
since.
end_timeExclusive end of the lookup window. Defaults to the current time.
sourceOnly consider records emitted by this Neon service.
limitMaximum 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.
Response
200Distinct values for the requested log field
Errors
The lookup could not be served as written. The body is always
ProjectBranchLogsInvalidQuery — see reason for the exact cause.
Logs are not available for this branch, or the project/branch was
not found. The body is always ProjectBranchLogsNotAvailable — see
reason for the exact cause.
General error
This endpoint can return the standard Neon API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
Retry guidance
If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.
Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.
Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.