v27

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-22216424765.0 KB
gateway.openapi_Gateway

Get Batch Job Logs

get/v1/accounts/{account_id}/batchJobs/{batch_job_id}:getLogs

Path parameters

account_idstring required

The Account Id

batch_job_idstring required

The Batch Job Id

Query parameters

ranksinteger[]

Ranks, for which to fetch logs.

pageSizeinteger

The maximum number of log entries to return. The maximum page_size is 10,000, values above 10,000 will be coerced to 10,000. If unspecified, the default is 100.

pageTokenstring

A page token, received from a previous GetBatchJobLogsRequest call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to GetBatchJobLogsRequest must match the call that provided the page token.

startTimestring date-time

Entries before this timestamp won't be returned. If not specified, up to page_size last records will be returned.

filterstring

Only entries matching this filter will be returned. Currently only basic substring match is performed.

startFromHeadboolean

Pagination direction, time-wise reverse direction by default (false).

readMaskstring

The fields to be returned in the response. If empty or "*", all fields will be returned.

Response

A successful response.

nextPageTokenstring

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.