The RudderStack .NET SDK lets you track your customer event data from your .NET applications and send it to your specified destinations via RudderStack.

Check the GitHub codebase to get a more hands-on understanding of the SDK.

SDK setup requirements

To set up the RudderStack Java SDK, the following prerequisites must be met:

• You need to set up a RudderStack account.
• Once signed up, set up a Java source in the dashboard. You should be able to see a Write Key for this source, as shown below:

• You will also need a data plane URL. Refer to the Glossary for more information on the data plane URL and where to find it.

Installing the .NET SDK

You can use NuGet to install the .NET SDK into your project.

Copy
Install-Package RudderAnalytics -Version <version>

Initializing the RudderStack client

To initialize the RudderStack client, run the following code snippet:

Copy
using RudderStack;

RudderAnalytics.Initialize(
    WRITE_KEY,
    new RudderConfig(dataPlaneUrl: DATA_PLANE_URL)
);

Sending events from RudderStack

Once the RudderStack client is initialized, you can then use it to send relevant customer events.

A sample track call is as shown:

Copy
RudderAnalytics.Client.Track(
    "userId",
    "CTA Clicked",
    new Dictionary<string, object> { {"plan", "premium"}, }
);

Identify

The identify call lets you associate a user to their actions as well as captures the relevant traits or properties related to that user.

A sample identify call is shown below:

Copy
RudderAnalytics.Client.Identify(
    "userId",
    new Dictionary<string, object> { {"subscription", "inactive"}, }
);

The identify method parameters are as described below:

Track

The track call lets you record the user actions along with their associated properties. Each user action is called an event.

A sample track call is shown below:

Copy
RudderAnalytics.Client.Track(
    "userId",
    "CTA Clicked",
    new Dictionary<string, object> {  {"plan", "premium"}, }
);

The track method parameters are:

Page

The page call allows you to record the page views on your website along with the other relevant information about the viewed page.

A sample page call is as shown:

Copy
RudderAnalytics.Client.Page(
    "userId",
    "Sign Up",
    new Dictionary<string, object> { {"url", "https://wwww.example.com/sign-up"}, }
);

The page method parameters are as described below:

Screen

The screen call is the mobile equivalent of the page call. It allows you to record the screen views on your mobile app along with the other relevant information about the app screen.

A sample screen call is as shown:

Copy
RudderAnalytics.Client.Screen(
    "userId",
    "Dashboard",
    new Dictionary<string, object> { {"name", "Paid Dashboard"}, }
);

The screen method parameters are as described below:

Group

The group call lets you associate an identified user to a group - either a company, project, or a team, and record any custom traits or properties associated with that group.

A sample group call is as shown:

Copy
RudderAnalytics.Client.Group(
    "userId",
    "accountId",
    new Dictionary<string, object> { {"role", "Owner"}, }
);

The group method parameters are as follows:

Alias

The alias call allows you to associate one identity with another.

A sample alias call is as shown:

Copy
RudderAnalytics.Client.Alias("anonUserId", "userId");

The alias method parameters are as mentioned below:

The options parameter

The options object contains the following fields:

Flushing events

To make sure no events are left in the queue, you can flush the events explicitly by using the SDK's flush() method, as shown:

Copy
RudderAnalytics.Client.Flush();

Logging

The RudderStack .NET SDK supports detailed logging. You can enable this feature as shown:

Copy
using RudderStack;

Logger.Handlers += LoggingHandler;

static void LoggingHandler(Logger.Level level, string message, IDictionary<string, object> args)
{
    if (args != null)
    {
        foreach (string key in args.Keys)
        {
            message += String.Format(" {0}: {1},", "" + key, "" + args[key]);
        }
    }
    Console.WriteLine(String.Format("[RudderAnalytics] [{0}] {1}", level, message));
}