Accelerate the Value of Data

Salesforce Connector Monitoring API

Learn how to use this API to monitor Salesforce connector and retrieve logs.

The Salesforce Connector Monitoring provides a means to monitor the Salesforce connector and retrieve logs.
Note: This functionality is specifically available on Google Cloud Platform (GCP).

Request

Make a GET request with the endpoint /logging to retrieve logs. The request must include headers with an authorization access token and the content type set to application/json.
  GET {SFDCConnectorURL}\logging
Table 1. Parameters
Parameter Required Description
HeadersAuthorizationYesAccess Token in format Bearer <accessToken> (see details in Authentication API).
Content-TypeYes Content-Type: application/json .
QuerytenantYesTenant ID
QuerylogLevelNo

If this parameter is not specified, then records with the following log levels are returned: DEBUG, INFO, WARNING, ERROR, CRITICAL

Example:

If the logLevel parameter is set to DEBUG, then records with the following levels are returned: DEBUG, INFO, WARNING, ERROR, CRITICAL

If the logLevel is set to INFO, then records with the following levels are returned: INFO, WARNING, ERROR, CRITICAL

QueryfromNoThis parameter allows to filter logs by time. By setting this parameter, only records with time later than from value is returned.

A string in RFC 3339 format. For example: 2019-10-02T15:01:23.045Z.

In filter expressions, timestamps can specify a timezone with Z or ±hh:mm. Timestamps are represented to nanosecond accuracy.
QuerytoNoThis parameter allows to filter logs by time. By setting this parameter, only records with time earlier than to value are returned.

A string in RFC 3339 format. For example: 2019-10-02T15:01:23.045Z.

In filter expressions, timestamps can specify a timezone with Z or ±hh:mm. Timestamps are represented to nanosecond accuracy.
QueryfilterNoThis parameter enables you to search for records that include text, which exactly matches with the value of the filter.
QuerynextPageTokenNoThis parameter enables you to retrieve the next set of search results, after the search criteria has retrieved 1000+ search results.

Response

Success: 200:
{
  "messages": [
    {
      "timestamp": "2018-12-15T11:08:55.919Z",
      "severity": "INFO",
      "message": "env:tst-01<abcd> <w1>: Using tenant abcd in  /tmp/sfdc-configs/dev/main"
    }
  ],
  "nextPageToken": "{nextPageToken}"
}
 
'messages' array is limited by 1000 records. if more records can be found using search criteria, then 'nextPageToken' attribute will be provided. If found record count less than 1000 then 'nextPageToken' will be missing.
 
Error:   400 Bad Request, { errors : [], warnings: [] }