Salesforce Connector Monitoring API
Learn how to use this API to monitor Salesforce connector and retrieve logs.
Request
/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| Parameter | Required | Description | |
|---|---|---|---|
| Headers | Authorization | Yes | Access Token in format Bearer <accessToken> (see details
in Authentication API). |
Content-Type | Yes | Content-Type: application/json . | |
| Query | tenant | Yes | Tenant ID |
| Query | logLevel | No |
If this parameter is not specified, then records with the following log levels are
returned: Example: If the If the |
| Query | from | No | This 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 withZ or
±hh:mm. Timestamps are represented to nanosecond accuracy. |
| Query | to | No | This 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 withZ or
±hh:mm. Timestamps are represented to nanosecond accuracy. |
| Query | filter | No | This parameter enables you to search for records that include text, which exactly matches with the value of the filter. |
| Query | nextPageToken | No | This 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: [] }