Analytics Event
Understanding analytics events of a session
Reclaim Protocol emits two types of logs:
- Server-Side Analytics Events: Stored on Reclaim servers, accessible via API. Useful for historical analysis, conversion tracking, and post-mortem debugging.
- Client-Side Log Events: Emitted locally by the InApp SDK. Useful for diagnosing issues with an InApp SDK session. View Client-Side Logs Documentation.
This document details the Server-Side Analytics Events.
Fetching analytics events from Reclaim
You can make an HTTP GET request to https://logs.reclaimprotocol.org/api/analytics-logs/session/:session_id to fetch all the analytics events of a session.
Understanding response from analytics event API
Response format
Following is the typescript type definition of the response:
Description of LogTypes
| Event Type | Level | Description |
|---|---|---|
FETCHED_PROVIDERS | INFO | The provider details have been fetched. |
RECLAIM_EXCEPTION | ERROR | An error has occurred in the verification journey. |
LOGIN_DETECTED | INFO | Login to the provider was detected (this can be inaccurate). |
LOGIN_REQUIRED_DETECTED | INFO | Detected that login is required (this can be inaccurate). |
USER_STARTED_VERIFICATION | INFO | User has started the verification process. |
USER_INIT_VERIFICATION | INFO | User initialized the verification. |
PROOF_GENERATION_STARTED | INFO | First proof generation has started. |
PROOF_GENERATION_RETRY | INFO | Retrying proof generation. |
PROOF_GENERATION_SUCCESS | INFO | Proof generated successfully. |
PROOF_GENERATION_FAILED | ERROR | Proof generation failed. |
PROOF_SUBMITTED | INFO | The proof has been successfully submitted. |
AI_PROOF_SUBMITTED | INFO | AI proof has been submitted. |
PROOF_SUBMISSION_FAILED | ERROR | Proof submission failed. |
PROOF_MANUAL_VERIFICATION_SUBMITED | INFO | Manual verification proof submitted. |
ERROR_SUBMITTED | INFO | Error details (Right now happens on cancellation) have been submitted. |
ERROR_SUBMISSION_FAILED | ERROR | Failed to submit error details. |
Description of RECLAIM_EXCEPTION in metadata
When the logType is RECLAIM_EXCEPTION, the metadata string parses to an object containing an exception field. The exception.type will be one of the following:
| Exception Name | Description |
|---|---|
ReclaimVerificationCancelledException | Verification cancelled (likely another verification started or invalid request). |
ReclaimVerificationDismissedException | Verification dismissed by user. |
ReclaimAttestorException | Exception related to attestor. |
ReclaimVerificationSkippedException | Verification skipped (proofs reused or manual review). |
InvalidRequestReclaimException | Request to start verification is invalid. |
ReclaimVerificationPlatformNotSupportedException | Platform not supported. |
ReclaimVerificationOutdatedSDKException | InApp SDK version is outdated. |
ReclaimVerificationManualReviewException | Verification submitted for manual review. |
ReclaimVerificationProviderNotFoundException | Provider not found. |
ReclaimVerificationAbortedException | Verification aborted by user (e.g. clicking cancel). |
ReclaimVerificationProviderScriptException | Provider script reported an error. |
ReclaimVerificationNoActivityDetectedException | No activity detected. |
ReclaimVerificationRequirementException | Claim creation requirements not met. |
ReclaimVerificationProviderLoadException | Provider load failed. |
ReclaimExpiredSessionException | Session expired. |
ReclaimInitSessionException | Error initializing session. |
[!NOTE] In case of
ReclaimVerificationProviderScriptException, the metadata may contain an additionalproviderErrorfield with more detailed error information from the provider script. In case ofReclaimVerificationAbortedException, the metadata may contain an additionalhas_errorboolean field which will be true if the user cancelled the verification after an error occurred during verification.