Native

Capture redacted first-party native app diagnostics

post/api/v1/native/telemetry

Request

  • Base URL: https://spoonjoy.app
  • URL: https://spoonjoy.app/api/v1/native/telemetry
  • Auth: none required

Headers

X-Request-Idstring

Optional client-generated request id. Spoonjoy echoes it in X-Request-Id and the REST envelope for logs, retries, and support.

Request body

event'bootstrap_failed' | 'bootstrap_offline' | 'app_intent_completed' | 'app_intent_failed' | 'auth_flow_started' | 'auth_flow_completed' | 'auth_flow_failed' | 'search_started' | 'search_completed' | 'search_failed' | 'settings_refresh_failed' | 'sync_failed' required

Constrained native diagnostic event name. Raw search text, error messages, and response bodies are not accepted.

stagestring nullable
environment'local' | 'preview' | 'production' | 'null' nullable
platform'ios' | 'macos' | 'null' nullable
appVersionstring nullable
buildNumberstring nullable
routestring nullable
errorTypestring nullable
requestIdstring nullable
statusinteger nullable
apiCodestring nullable
retrystring nullable
accountBoundboolean nullable
hasRenderableCacheContentboolean nullable
recipesinteger nullable
cookbooksinteger nullable
shoppingItemsinteger nullable
queuedMutationsinteger nullable
intentNamestring nullable
intentActionKindstring nullable
intentOutcomestring nullable
intentReturnsValueboolean nullable
intentQueuedMutationIdstring nullable
intentQueuedMutationKindstring nullable
intentOpensUrlstring nullable
authProviderstring nullable
authPhasestring nullable
authOutcomestring nullable
authDiagnosticCodestring nullable
authSessionStatestring nullable
authCredentialPresentboolean nullable
authIdentityTokenPresentboolean nullable
authRawNoncePresentboolean nullable
authEmailPresentboolean nullable
authFullNamePresentboolean nullable
authOAuthStatePresentboolean nullable
authRedirectSchemestring nullable
authRedirectHoststring nullable
searchScope'all' | 'recipes' | 'cookbooks' | 'chefs' | 'shopping-list' | 'null' nullable

Canonical search scope. This field never contains search text.

searchQueryLengthinteger nullable

Search query length only. The raw query is never accepted.

searchResultCountinteger nullable
durationMillisecondsinteger nullable

Response

Success

okunknown required
requestIdstring required

Changes

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