Process group log monitoring API - POST filtered log content

Gets the content of the specified log.

The log content can be retrieved using this call only when logAnalysisStatus equals READY in the job status call.

The request produces an application/json payload.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/process-groups/{pgId}/logs/jobs/{jobId}/records
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v1/entity/infrastructure/process-groups/{pgId}/logs/jobs/{jobId}/records

Authentication

To execute this request, you need the Read log content (LogExport) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter Type Description In Required
pgId string

The Dynatrace entity ID of the required process group.

path required
jobId string

The ID of the required log analysis job.

You can retrieve it from the response of the POST analysis job request.

path required
scrollToken string

The scrollToken value from the previous response.

You can use it to get the next page of results. Without it, the first page is always returned.

query optional
pageSize integer

The number of records per result page.

If not set, each page contains 100 results.

Maximum allowed value is 10000.

query optional
body FilterLogContent

Filter the log content by the specified criteria.

See the Search patterns in log data and parse results help page for the syntax definition and examples.

body optional

The FilterLogContent object

A query to filter log content.

Element Type Description Required
filterQuery string

The query for filtering.

See the Search patterns in log data and parse results help page for the syntax definition and examples.

optional
sortingAttributes SortingAttributes optional

The SortingAttributes object

How to sort the results.

Element Type Description Required
sortAscending boolean

Sort ascending (true) or descending (false).

optional
sortFieldName string

The field to sort by.

optional

Response format

When scrolling through the result records using a scroll token, the last result page contains an empty records array and no scrollToken field.

The LogJobRecordsResult object

The results of the log analysis job.

Element Type Description
records LogRecord[]

The list of log analysis results.

The last page contains empty list.

scrollToken string

The scroll token for the next page of results.

Without it you'll get the first page again.

The LogRecord object

The analysis result for a single log entry.

Element Type Description
timestamp integer

The timestamp of the log entry, in UTC milliseconds.

logLevel string

The severity level of the log entry.

hostId string

The entity ID of the host that produced the log.

Not applicable to OS logs.

text string

The text of the log entry.

customFields object

The map of the log entry custom fields.