Beta APIs

[beta] Get a Function run.

Retrieve the execution summary for a specific Function run, identified by the correlationId returned from the start run endpoint.

<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}/runs/{correlationId}

Request

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

Path parameters

namestring required

The name of the Function.

correlationIdstring required

The unique correlationId of the Function run, returned by the start run endpoint.

Response

OK response.

Example response

{
  "data": {
    "completedAtTime": "2021-01-01T00:00:30Z",
    "context": {
      "requestId": "req-550e8400-e29b-41d4-a716-446655440000",
      "requestPayload": "Optio magnam earum sunt exercitationem.",
      "responsePayload": "Aspernatur eos exercitationem."
    },
    "correlationId": "550e8400-e29b-41d4-a716-446655440000",
    "name": "my-function",
    "startedAtTime": "2021-01-01T00:00:00Z",
    "status": "success"
  }
}

Changes

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