SAsamsara
Beta APIs

[beta] Get Function logs.

Retrieve paginated log entries for a specific Function within a given time range. Logs are produced during Function executions and can be filtered by text content.

<b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select Read Functions under the Functions category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

get/functions/{name}/logs

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Path parameters

namestring required

The name of the Function whose logs to retrieve.

Query parameters

startTimestring date-time required

Required RFC 3339 timestamp for the beginning of the log time range.

endTimestring date-time required

Required RFC 3339 timestamp for the end of the log time range.

afterstring

If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.

limitinteger

The maximum number of log entries to return per page. Default is 100.

filterTextstring

Optional text to filter log entries. Only logs containing this text will be returned.

Response

OK response.

Example response

{
  "data": [
    {
      "log": "Processing batch of 50 records...",
      "loggedAtTime": "2024-01-01T12:00:00Z"
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.