Telemetry

Report SDK errors

Receives error telemetry from the frontend SDK. Errors are logged to observability backend for monitoring and debugging.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow, acting as the user who authorized it. See Authentication for partners.
  • Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
  • Client credentials access token (OAuth2ClientCredentials) — obtained through the Client Credentials flow or the Refresh Token flow. See Authentication for partners.
  • Employee-scoped access token (OAuth2Assertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant. See OAuth Assertion.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.
  • Client token (ClientToken) — a partner client_token, accepted only on the endpoints that list it. See Authentication for partners.
post/v1/sdk/telemetry-errors

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/sdk/telemetry-errors
  • Auth
    • OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token
    • or HTTP bearer
    • or HTTP bearer

Request body

contextobject nullable

Context

Example request

{
  "context": {
    "userId": "user123"
  },
  "error": {
    "category": "RENDER_ERROR",
    "component_stack": [
      "Component1",
      "Component2"
    ],
    "message": "Unable to render component",
    "name": "RenderError",
    "severity": "error",
    "stack": "Error: ...\n  at ..."
  },
  "metadata": {
    "environment": "production",
    "sdk_version": "1.0.0",
    "timestamp": "2024-01-15T10:30:00Z",
    "url": "https://example.com/page",
    "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)"
  }
}

Response

No Content

Changes

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