Insightdive 1.2.0

Insightdive .NET / Avalonia SDK

Official .NET SDK for Insightdive — anonymous in-app feedback surveys.

Installation

dotnet add package Insightdive

Quick start (Avalonia)

// App.axaml.cs — configure once at startup
InsightdiveSDK.Configure(new InsightdiveOptions
{
    Tenant            = "acme",
    Survey            = "nps-q1",
    ApiKey            = "your-api-key",
    ProductVersion    = Assembly.GetEntryAssembly()?.GetName().Version?.ToString(),
    ProductIdentifier = "desktop",
    Locale            = CultureInfo.CurrentCulture.Name,
    Theme             = "light",
});

// Any Window — show as a modal dialog
if (await InsightdiveSDK.Instance.IsAvailableAsync())
{
    var result = await InsightdiveSDK.Instance.ShowAsync(this); // 'this' = Avalonia Window
    if (result?.Status == FeedbackStatus.Completed)
        Console.WriteLine($"Submitted: {result.SubmissionId}");
}

Event-based triggering

// Show only when a specific SDK event fires
if (await InsightdiveSDK.Instance.TriggerAsync("onboarding_completed"))
    await InsightdiveSDK.Instance.ShowAsync(this);

Lifecycle events

InsightdiveSDK.Instance.FeedbackEventOccurred += (_, e) =>
{
    switch (e)
    {
        case FeedbackViewedEvent v:    Console.WriteLine($"Viewed  session={v.SessionId}"); break;
        case FeedbackCompletedEvent c: Console.WriteLine($"Done    sub={c.SubmissionId}");  break;
        case FeedbackDismissedEvent d: Console.WriteLine($"Closed  after={d.Result.Duration}"); break;
    }
};

Inline view

// Embed the survey directly in your layout instead of a modal
using Insightdive.Avalonia_;

var opts   = InsightdiveSDK.Instance.Options;
var token  = await InsightdiveSDK.Instance.FetchEmbedTokenAsync();
var url    = UrlBuilder.SurveyUrl(opts, token);
var survey = new InsightdiveSurveyControl(InsightdiveSDK.Instance, url);
survey.EventOccurred += (_, e) => { /* handle events */ };
myPanel.Children.Add(survey);

Pure .NET (no UI)

The netstandard2.0 target exposes the status-checking API without any UI dependency:

InsightdiveSDK.Configure(new InsightdiveOptions
{
    Tenant = "acme",
    Survey = "nps-q1",
    ApiKey = "your-api-key",
});

bool available = await InsightdiveSDK.Instance.IsAvailableAsync();
bool match     = await InsightdiveSDK.Instance.TriggerAsync("app_launched");

Screenshot capture

When an insight has screenshot collection enabled (Admin → Insight → Settings → Delivery), ShowAsync(ownerWindow) renders the owner window to a PNG just before the modal opens and attaches it to the response. The screenshot is of the UI — never the user.

• No setup required beyond the existing ShowAsync(this) call — the net8.0 Avalonia target captures the owner window automatically.
• The flag is read from the status endpoint, so call IsAvailableAsync() / TriggerAsync() before ShowAsync().
• Capture is best-effort and size-capped; failures are swallowed and the survey still opens.
• Only available on the net8.0 Avalonia target (the netstandard2.0 status-only target has no UI to capture).

Supported targets

Operator context fields

Stamp arbitrary application context on every submission — plan tier, feature flags, active surface, A/B cohort — without collecting any user identity. The admin can filter, segment, and run AI analysis per context dimension.

InsightdiveSDK.Configure(new InsightdiveOptions
{
    Tenant  = "acme",
    Survey  = "nps-q1",
    ApiKey  = "ik_abc123...",
    Context = new Dictionary<string, object>
    {
        ["plan"]                  = "enterprise",
        ["trial_days_remaining"]  = 12,
        ["feature_export_v2"]     = true,
        ["surface"]               = "settings",
    },
});

Constraints (enforced server-side; invalid entries are silently dropped):

• Max 20 keys per dictionary
• Key format: [a-z0-9_], max 64 characters
• Values: string, numeric (int, long, double), or bool — no nested objects
• String values: max 255 characters
• Total JSON payload: max 4 KB

Context values are visible in Admin → Responses (detail view) and included in CSV exports as context.<key> columns.

Respondent token

Let the operator correlate responses with their own user records — without ever exposing a user identity to Insightdive. Compute an opaque hash server-side and pass it as RespondentToken:

using System.Security.Cryptography;
using System.Text;

static string ComputeToken(string userId, string workspaceSalt)
{
    var data = Encoding.UTF8.GetBytes(userId + workspaceSalt);
    var hash = SHA256.HashData(data);
    return Convert.ToHexString(hash).ToLowerInvariant();
}

InsightdiveSDK.Configure(new InsightdiveOptions
{
    Tenant          = "acme",
    Survey          = "nps-q1",
    ApiKey          = "ik_abc123...",
    RespondentToken = ComputeToken(currentUser.Id, "my-secret-salt"),
});

What Insightdive stores: the hash only — no ability to reverse it to a user.
What the operator can do: compute the same hash from their own database and look up all responses for that hash in Admin → Responses.
GDPR note: Insightdive is a processor with no identification capability. The operator (controller) owns the correlation.

Tip: rotate workspaceSalt if you want to "forget" historical correlations without deleting data.

Constraints: max 128 characters, characters [a-zA-Z0-9-_] only.

Options reference