Skip to content

sreekanthpulagam/rakam-csharp-client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Rakam.Client - the C# library for the Rakam API Documentation

An analytics platform API that lets you create your own analytics services.

This C# SDK is automatically generated by the Swagger Codegen project:

  • API version: 0.5
  • SDK version: 0.5
  • Build date: 2016-07-20T00:30:53.409+03:00
  • Build package: class io.swagger.codegen.languages.CSharpClientCodegen

Frameworks supported

  • .NET 4.0 or later
  • Windows Phone 7.1 (Mango)

Dependencies

The DLLs included in the package may not be the latest version. We recommned using [NuGet] (https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

Installation

Run the following command to generate the DLL

  • [Mac/Linux] /bin/sh build.sh
  • [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Rakam.Client.Api;
using Rakam.Client.Client;
using Model;

Getting Started

using System;
using System.Diagnostics;
using Rakam.Client.Api;
using Rakam.Client.Client;
using Model;

namespace Example
{
    public class Example
    {
        public void main()
        {
            
            // Configure API key authorization: master_key
            Configuration.Default.ApiKey.Add("master_key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("master_key", "Bearer");

            var apiInstance = new AdminApi();
            var projectAddCustomFieldsToSchema = new ProjectAddCustomFieldsToSchema(); // ProjectAddCustomFieldsToSchema | 

            try
            {
                // Add fields to collections by transforming other schemas
                List<SchemaField> result = apiInstance.AddCustomFieldsToSchema(projectAddCustomFieldsToSchema);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.AddCustomFieldsToSchema: " + e.Message );
            }
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://app.rakam.io/

Class Method HTTP request Description
AdminApi AddCustomFieldsToSchema POST /project/schema/add/custom Add fields to collections by transforming other schemas
AdminApi AddFieldsToSchema POST /project/schema/add Add fields to collections
AdminApi CheckApiKeys POST /project/check-api-keys Create API Keys
AdminApi CheckLockKey POST /admin/lock_key Check lock key
AdminApi Collections POST /project/collection Get collection names
AdminApi CreateApiKeys POST /project/create-api-keys Create API Keys
AdminApi CreateProject POST /project/create Create project
AdminApi DeleteProject DELETE /project/delete Delete project
AdminApi GetConfigurations GET /admin/configurations List installed modules
AdminApi GetProjects GET /project/list List created projects
AdminApi GetStats POST /project/stats Get project stats
AdminApi GetTypes GET /admin/types Get types
AdminApi RevokeApiKeys DELETE /project/revoke-api-keys Revoke API Keys
AdminApi Schema POST /project/schema Get collection schema
CollectApi BatchEvents POST /event/batch Collect multiple events
CollectApi BulkEvents POST /event/bulk Collect Bulk events
CollectApi BulkEventsRemote POST /event/bulk/remote Collect bulk events from remote
CollectApi CollectEvent POST /event/collect Collect event
CollectApi CommitBulkEvents POST /event/bulk/commit Commit Bulk events
ContinuousqueryApi CreateQuery POST /continuous-query/create Create stream
ContinuousqueryApi DeleteQuery POST /continuous-query/delete Delete stream
ContinuousqueryApi GetQuery POST /continuous-query/get Get continuous query
ContinuousqueryApi GetSchemaOfQuery POST /continuous-query/schema Get query schema
ContinuousqueryApi ListQueries POST /continuous-query/list List queries
ContinuousqueryApi TestQuery POST /continuous-query/test Test continuous query
EventexplorerApi AnalyzeEvents POST /event-explorer/analyze Perform simple query on event data
EventexplorerApi CreatePrecomputedTable POST /event-explorer/pre_calculate Create Pre-computed table
EventexplorerApi GetEventStatistics POST /event-explorer/statistics Event statistics
EventexplorerApi GetExtraDimensions GET /event-explorer/extra_dimensions Event statistics
FunnelApi AnalyzeFunnel POST /funnel/analyze Execute query
MaterializedviewApi CreateView POST /materialized-view/create Create view
MaterializedviewApi DeleteView POST /materialized-view/delete Delete materialized view
MaterializedviewApi GetSchemaOfView POST /materialized-view/schema Get schemas
MaterializedviewApi GetView POST /materialized-view/get Get view
MaterializedviewApi ListViews POST /materialized-view/list List views
QueryApi Execute POST /query/execute Execute query on event data-set
QueryApi Explain POST /query/explain Explain query
QueryApi Metadata POST /query/metadata Test query
RealtimeApi CreateTable POST /realtime/create Create report
RealtimeApi DeleteTable POST /realtime/delete Delete report
RealtimeApi ListTables POST /realtime/list List queries
RealtimeApi QueryTable POST /realtime/get Get report
RecipeApi ExportRecipe GET /recipe/export Export recipe
RecipeApi InstallRecipe POST /recipe/install Install recipe
RetentionApi AnalyzeRetention POST /retention/analyze Execute query
UserApi CreateSegment POST /user/create_segment Get events of the user
UserApi CreateUser POST /user/create Create new user
UserApi CreateUsers POST /user/batch/create Create multiple new users
UserApi GetEvents POST /user/get_events Get events of the user
UserApi GetMetadata GET /user/metadata Get user storage metadata
UserApi GetUser POST /user/get Get user
UserApi IncrementProperty POST /user/increment_property Set user property
UserApi SearchUsers POST /user/search Search users
UserApi SetProperties POST /user/set_properties Set user properties
UserApi SetPropertiesOnce POST /user/set_properties_once Set user properties once
UserApi UnsetProperty POST /user/unset_properties Unset user property
UseractionApi Batch POST /user/action/email/batch Apply batch operation
UseractionApi Send POST /user/action/email/single Perform action for single user

Documentation for Models

Documentation for Authorization

read_key

  • Type: API key
  • API key parameter name: read_key
  • Location: HTTP header

master_key

  • Type: API key
  • API key parameter name: master_key
  • Location: HTTP header

write_key

  • Type: API key
  • API key parameter name: write_key
  • Location: HTTP header

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages