Retrieve Task Logs

This page is no longer maintained (Mar 29, 2023). For the most current information, go to https://docs.snaplogic.com/public-apis/get-log-org.html.

 

GET /log/{org}

Overview

This API retrieves the Task log information for the specified Org.

Prerequisites

  • Read access to the requested assets

Request

Path Parameters

Key

Description

Key

Description

pod_path

Required. The path to your SnapLogic pod.

Example: elastic.snaplogic.com

org

Required. The name of the SnapLogic Org.

Query Parameters

Key

Type

Description

Key

Type

Description

ruuid

string

Required. Returns log information about the task with the specified runtime ID.

log_level

string

Returns log information at the specified level of detail.

Valid values:

  • error – Returns only error logs.

  • warn – Returns both warning logs and error logs.

  • info – Returns all logged information, including warning logs and error logs.

Default: info

limit

integer

Returns no more than the specified number of results. You can use limit and offset for pagination.

Valid values: 1 through 100,000

Default: 100

Request Header

Specify Basic for authorization and application/json for content type.

Request Body

None.

Response

Response Body

{ "response_map": { "extra": {}, "total": ..., "entries": [ { "_source": { "msg": "...", "lvl": "...", "ts": "...", "prc": "...", "fi": "..." } }, ... { "_source": { "xid": "...", "snrd": "...", "prc": "...", "linid": "...", "ts": "...", "plrd": "...", "fi": "...", "msg": "...", "lvl": "...", "snlb": "...", "exc": "..." } } ] }, "http_status_code": 200 }

Key

Type

Description

Key

Type

Description

extra

object

 

total

integer

The number of log entries returned.

entries

array of objects

Metadata about the source of each log entry.

  • msg. The message in the log.

  • lvl. The type of the log entry.
    Possible values:

    • INFO

    • WARN

    • ERROR

  • ts. The timestamp of the entry. Format: UTC

  • prc. The process that was logged.

  • fi. The line in the code that generated the log entry.

If lvl is ERROR:

  • xid. The transaction ID.

  • snrd. The Snap runtime ID.

  • linid.

  • plrd. The Pipeline runtime ID.

  • snlb. The Snap label or name.

  • exc. Any exception that occurred.