MeridixStudioWebAPI 1.0.0-beta

Meridix Studio WebApi Client

A .NET Standard 2.0 client library for interacting with the Dstny Analytics Platform (formerly Meridix Studio) HTTP API.

Features

• ✅ Token-based Authentication – Secure request signing using API tokens and secrets
• ✅ Multiple API Endpoints – Report generation, customer/reseller management, user administration, and more
• ✅ Report API v1.1 – Generate reports synchronously or asynchronously with flexible parameters
• ✅ Cross-platform – Targets .NET Standard 2.0 (compatible with .NET Framework 4.6.1+, .NET Core 2.0+, .NET 5+)
• ✅ Proxy Support – Configure custom web proxies for restricted environments
• ✅ HTTP Method Override – Bypass verb restrictions (PUT/DELETE) using X-HTTP-Method-Override

Installation

NuGet Package Manager

Install-Package MeridixStudioWebAPI

.NET CLI

dotnet add package MeridixStudioWebAPI

Getting Started

1. Create a Client Instance

Authenticate using your API token and secret (obtained from Dstny Analytics Platform):

using Meridix.Studio.Api;

var url = "https://your-instance.dstny.com";
var token = "your-api-token";
var secret = "your-api-secret";

var client = MeridixStudioClient.Create(url, token, secret);

// Validate API connectivity (optional)
client.ValidateApiAccess();

2. Generate a Report

using System.Globalization;
using Meridix.Studio.Api.DataTransferObjects.Reports.Version11;

var reportApi = client.ReportApiV11();

var parameters = new ReportV11ParametersDto
{
    CustomerId = 4,
    ModuleName = "BcsCdrV2",
    ReportName = "BcsUserId",
    FromDate = "2025-11-01",
    ToDate = "2025-11-30",
    FromMinute = 420,
    ToMinute = 1440,
    IntervalMinutes = 30,
    CollectionPointIdentifier = "7",
    MeasurementObjectType = "TelepoBcsUserId",
    MeasurementObjectIdentifiers = new List<string> { "user123" },
    IncludeGroupings = new List<string> { "Period" },
    ResultGrouping = "Total",
    IgnoreNonExistingMeasurementObjectIdentifiers = true,
    IncludeSpecificationLists = true
};

var result = reportApi.Generate(parameters, new CultureInfo("sv-SE"));

// Access report data
var periodData = result.Presentations.Groupings["period"];
foreach (var item in periodData.Items)
{
    Console.WriteLine(item.ToString());
}

3. List Measurement Objects

var reportApi = client.ReportApiV11();
var measurementObjects = reportApi.GetAvailableMeasurementObjects();

foreach (var mo in measurementObjects)
{
    Console.WriteLine($"{mo.ObjectIdentifier} | {mo.Description} | {mo.Type}");
}

4. Manage Collection Points

var unitsApi = client.UnitsApi(customerId: 4);
var collectionPoints = unitsApi.ListCollectionPoints();

foreach (var cp in collectionPoints)
{
    Console.WriteLine($"{cp.Id} | {cp.Name} | {cp.PointIdentifier}");
}

5. Asynchronous Report Generation

For long-running reports, use async generation with polling:

var handle = reportApi.BeginGenerate(parameters, new CultureInfo("en-US"));

while (!handle.IsCompleted && handle.Error == null)
{
    await Task.Delay(2000); // Poll every 2 seconds
    reportApi.UpdateHandle(ref handle);
}

if (handle.IsCompleted && handle.Error == null)
{
    var result = handle.Result;
    // Process result
}
else
{
    Console.WriteLine($"Error: {handle.Error}");
}

API Components

Configuration

Set Default Culture

client.DefaultCulture = new CultureInfo("en-US");

Enable HTTP Method Override (default: enabled)

client.UseHttpMethodOverride = true; // Converts PUT/DELETE to POST with header

Configure Proxy

client.Proxy = new WebProxy("http://proxy.company.com:8080")
{
    Credentials = new NetworkCredential("username", "password")
};

Enable Debug Logging

client.OnOutput += (sender, args) =>
{
    Console.WriteLine($"[API] {args.Message}");
};

Common Use Cases

Get Available Modules and Reports

var reportApi = client.ReportApiV11();
var modules = reportApi.GetAvailableModules(new CultureInfo("en-US"));

foreach (var module in modules)
{
    Console.WriteLine($"{module.Key}: {module.Value}");
    
    var reports = reportApi.GetAvailableReports(module.Key);
    foreach (var report in reports)
    {
        Console.WriteLine($"  - {report.Key}: {report.Value}");
    }
}

Single Sign-On (SSO) URL Generation

var ssoUrl = client.CreateSingleSignOnUrl("username@domain.com");
// Redirect user to ssoUrl for automatic login

Get Ticket Information

var customerId = client.GetTicketCustomerId();
var customerName = client.GetTicketCustomerName();
var userId = client.GetTicketUserId();
var username = client.GetTicketUsername();

Update Customer Privacy Settings

var customerApi = client.CustomerApi();
var customer = customerApi.Get(customerId);

customer.PrivacyPolicyDelete.Enabled = true;
customer.PrivacyPolicyDelete.Value = 90;
customer.PrivacyPolicyDelete.Unit = "Days";

customer.PrivacyPolicyMask.Enabled = true;
customer.PrivacyPolicyMask.Value = 6;
customer.PrivacyPolicyMask.Unit = "Months";

customerApi.Update(customer);

Requirements

• .NET Standard 2.0 or higher
• Newtonsoft.Json 13.0.4+
• System.ComponentModel.Annotations

Compatible Runtimes

• .NET Framework 4.6.1+
• .NET Core 2.0+
• .NET 5, 6, 7, 8+
• Xamarin
• Unity

Support

For issues, questions, or API documentation:

• Dstny Analytics Support: Contact your account representative
• API Documentation: Available in your Dstny Analytics Platform instance

License

This project is licensed under the MIT License.

MIT License

Copyright (c) 2023 Dstny Analytics

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Release Notes

Version 1.0.0 (Current)

• ✨ Migrated to .NET Standard 2.0 for cross-platform compatibility
• 📦 Consolidated packaging metadata into project file
• 📚 Improved XML documentation generation
• 🔒 Added deterministic builds and symbol packages (.snupkg)
• 🧹 Removed legacy AssemblyInfo.cs in favor of SDK-style properties

Version 0.4.88

• Previous stable release for .NET Framework

Acknowledgments

Originally developed as Meridix Studio, now part of Dstny Analytics suite.

Maintained by Dstny Analytics
Copyright © 2013-2025 Dstny Analytics