Singular

https://support.singular.net/hc/en-us
Admin
Singular is a marketing intelligence platform that provides mobile attribution, analytics, fraud...
Tokens:1,680,479
Snippets:11,133
Trust Score:10
Update:19 hours ago
Show doc for...
Tokens:
Raw
### Singular.startSession Usage Example (Swift)

Source: https://support.singular.net/hc/en-us/articles/42098675713819-iOS-SDK-Methods-Reference?navigation_side_bar=true

Swift example showing simple session start and session start with deep link handler.

```swift
// Simple session start
Singular.startSession("API_KEY", withKey: "API_SECRET")

// Session start with deep link handler
Singular.startSession("API_KEY", 
                      withKey: "API_SECRET", 
                      andLaunchOptions: launchOptions, 
                      withSingularLinkHandler: { params in
    if let deeplink = params.deeplink {
        print("Deep link received: \(deeplink)")
    }
})
```

--------------------------------

### Singular.start Usage Example (Objective-C)

Source: https://support.singular.net/hc/en-us/articles/42098675713819-iOS-SDK-Methods-Reference?navigation_side_bar=true

Objective-C example showing how to create a SingularConfig, set custom user ID and session timeout, and call [Singular start:config].

```objectivec
// Create configuration object
SingularConfig *config = [[SingularConfig alloc] initWithApiKey:@"SDK_KEY" andSecret:@"SDK_SECRET"];

// Configure additional options if needed
config.customUserId = @"user-123456";
config.sessionTimeout = 60;

// Initialize the SDK
[Singular start:config];
```

--------------------------------

### Complete Configuration Example

Source: https://support.singular.net/hc/en-us/articles/37155265071259-Cordova-SDK-Configuration-Methods-Reference?navigation_side_bar=true

Comprehensive JavaScript example showing how to configure the Singular SDK with multiple options and initialize it.

```javascript
var Singular = cordova.plugins.SingularCordovaSdk;
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

// Create configuration with API key and secret
var config = new SingularConfig('YOUR_API_KEY', 'YOUR_SECRET')
  .withCustomUserId('user123456')
  .withSessionTimeoutInSec(120)
  .withLoggingEnabled()
  .withSingularLink(function(params) {
    console.log('Deep link:', params.deeplink);
  })
  .withConversionValueUpdatedHandler(function(value) {
    console.log('Conversion value:', value);
  })
  .withGlobalProperty('user_tier', 'premium', true)
  .withGlobalProperty('app_version', '2.1.0', true)
  .withShortLinkResolveTimeout(15);

// Initialize the SDK
Singular.init(config);
```

--------------------------------

### Singular.startSession Usage Example (Objective-C)

Source: https://support.singular.net/hc/en-us/articles/42098675713819-iOS-SDK-Methods-Reference?navigation_side_bar=true

Objective-C example showing simple session start and session start with deep link handler.

```objectivec
// Simple session start
[Singular startSession:@"API_KEY" withKey:@"API_SECRET"];

// Session start with deep link handler
[Singular startSession:@"API_KEY" 
               withKey:@"API_SECRET" 
      andLaunchOptions:launchOptions 
withSingularLinkHandler:^(SingularLinkParams *params) {
    NSLog(@"Deep link received: %@", params.deeplink);
}];
```

--------------------------------

### Initialize - Usage Example

Source: https://support.singular.net/hc/en-us/articles/42348922887195-Unreal-Engine-SDK-Methods-Reference

Initializes the Singular SDK with required parameters and logs success or failure. Uses USingularSDKBPLibrary::Initialize().

```cpp
// Initialize SDK with required parameters
FString ApiKey = TEXT("SDK KEY");
FString ApiSecret = TEXT("SDK SECRET");

bool Success = USingularSDKBPLibrary::Initialize(
    ApiKey,
    ApiSecret,
    60,                    // Session timeout in seconds
    TEXT(""),             // Custom user ID (optional)
    true,                 // SKAdNetwork enabled
    false,                // Manual SKAN conversion management
    0,                    // Wait for tracking authorization timeout
    false,                // OAID collection
    true,                 // Enable logging for debugging
    3,                    // Log level (0-5)
    false,                // Clipboard attribution
    TEXT(""),             // Facebook App ID (optional)
    TEXT("")              // Custom SDID (optional)
);

if (Success)
{
    UE_LOG(LogTemp, Log, TEXT("Singular SDK initialized successfully"));
}
else
{
    UE_LOG(LogTemp, Error, TEXT("Failed to initialize Singular SDK"));
}
```

--------------------------------

### GET Publisher Blacklist Example Output

Source: https://support.singular.net/hc/en-us/articles/40379029045531-Publisher-Blacklist-API-for-Singular-Fraud-Prevention

Example JSON response from the GET endpoint showing the structure of the publisher blacklist data.

```json
{
  "data": {
    "Google AdWords": [
      {
        "publisher_name": "AdMob Publisher",
        "publisher_id": "ca-app-pub-123456789"
      },
      {
        "publisher_hashed_id": "abc123def456",
        "sub_publisher": "sub_pub_001"
      }
    ]
  }
}
```

--------------------------------

### Complete Configuration Example

Source: https://support.singular.net/hc/en-us/articles/36953086405147-React-Native-SDK-Configuration-Methods-Reference?navigation_side_bar=true

Demonstrates how to create a comprehensive SDK configuration by chaining multiple configuration methods together, including initialization and event handling.

```APIDOC
## Complete Configuration Example

### Description
Demonstrates how to create a comprehensive configuration by chaining multiple configuration methods together, including initialization and event handling.

### Usage Example

#### New Architecture (TurboModule direct API, React Native 0.76+)
```typescript
import NativeSingular from 'singular-react-native/js/NativeSingular';
import type { SingularConfig } from 'singular-react-native/js/NativeSingular';
import { NativeEventEmitter } from 'react-native';

// Create comprehensive configuration
const config: SingularConfig = {
  apikey: 'YOUR_API_KEY',
  secret: 'YOUR_SECRET',

  // Basic options
  sessionTimeout: 120,
  enableLogging: true,

  // User identification
  customUserId: 'user123456',

  // Global properties
  globalProperties: {
    app_version: {
      Key: 'app_version',
      Value: '1.2.3',
      OverrideExisting: true
    },
    user_type: {
      Key: 'user_type',
      Value: 'premium',
      OverrideExisting: true
    }
  },

  // Privacy settings
  limitDataSharing: false,

  // Email attribution
  espDomains: ['mailchimp.com', 'sendgrid.net'],

  // Facebook integration
  facebookAppId: 'YOUR_FACEBOOK_APP_ID',

  // SKAdNetwork (iOS)
  skAdNetworkEnabled: true,
  waitForTrackingAuthorizationWithTimeoutInterval: 300,

  // Push notifications
  pushNotificationsLinkPaths: [
    ['data', 'deeplink'],
    ['notification', 'data', 'url']
  ],

  // Branded domains
  brandedDomains: ['yourcompany.com', 'go.yourcompany.com'],
};

// Initialize the SDK
NativeSingular.init(config);

// Use event emitter for all callbacks/handlers
const emitter = new NativeEventEmitter(NativeSingular);

// Singular Link (deep links)
emitter.addListener('SingularLinkHandler', (params) => {
  if (params.deeplink) {
    console.log('Deep link:', params.deeplink);
    // Handle deep link navigation
  }
  if (params.passthrough) {
    console.log('Passthrough data:', params.passthrough);
  }
});

// Attribution callback
emitter.addListener('DeviceAttributionCallbackHandler', (attributionData) => {
  console.log('Attribution:', attributionData);
});

// SDID callbacks (if needed)
emitter.addListener('DidSetSdidCallback', (result) => {
  console.log('SDID set:', result);
});
emitter.addListener('SdidReceivedCallback', (result) => {
  console.log('SDID received:', result);
});
```

#### Old Architecture
```javascript
import { Singular, SingularConfig } from 'singular-react-native';

// Create comprehensive configuration
const config = new SingularConfig('YOUR_API_KEY', 'YOUR_SECRET')
  // Basic options
  .withSessionTimeoutInSec(120)
  .withLoggingEnabled()
  
  // User identification
  .withCustomUserId('user123456')
  
  // Global properties
  .withGlobalProperty('app_version', '1.2.3', true)
  .withGlobalProperty('user_type', 'premium', true)
  
  // Deep links
  .withSingularLink((params) => {
    if (params.deeplink) {
      console.log('Deep link:', params.deeplink);
      // Handle deep link navigation
    }
  })
  .withShortLinkResolveTimeout(10)
  
  // Attribution callback
  .withDeviceAttributionCallbackHandler((attributionData) => {
    console.log('Attribution:', attributionData);
  })
  
  // Privacy settings
  .withLimitDataSharing(false)
  
  // Email attribution
  .withEspDomains(['mailchimp.com', 'sendgrid.net'])
  
  // Facebook integration
  .withFacebookAppId('YOUR_FACEBOOK_APP_ID')
  
  // SKAdNetwork (iOS)
  .withSkAdNetworkEnabled(true)
  .withWaitForTrackingAuthorizationWithTimeoutInterval(30)
  
  // Push notifications
  .withPushNotificationsLinkPaths([
    ['data', 'deeplink'],
    ['notification', 'data', 'url']
  ])
  
  // Branded domains
  .withBrandedDomains(['yourcompany.com', 'go.yourcompany.com']);

// Initialize the SDK
Singular.init(config);
```
```

--------------------------------

### S3 Bucket Name Example

Source: https://support.singular.net/hc/en-us/articles/360034681492-S3-Data-Destination

Example bucket name that must start with 'singular-s3-exports-'.

```java
singular-s3-exports-mycompanyname
```

--------------------------------

### Complete SDK Configuration Example (Objective-C)

Source: https://support.singular.net/hc/en-us/articles/42098616285339-iOS-SDK-Configuration-Methods-Reference?navigation_side_bar=true

Creates a SingularConfig with API credentials, sets basic options, global properties, deep link handling, user details, and starts the SDK. User details are hashed by the SDK before being sent.

```objectivec
// Create configuration with API credentials
SingularConfig *config = [[SingularConfig alloc] initWithApiKey:@"SDK KEY" 
                                                       andSecret:@"YOUR_SECRET"];

// Set basic options
config.waitForTrackingAuthorizationWithTimeoutInterval = 60;
config.clipboardAttribution = YES;

// Set global properties
[config setGlobalProperty:@"app_version" 
                withValue:@"1.2.3" 
         overrideExisting:YES];
[config setGlobalProperty:@"user_type" 
                withValue:@"premium" 
         overrideExisting:YES];

// Configure deep links
config.launchOptions = launchOptions;
config.singularLinksHandler = ^(SingularLinkParams *params) {
    NSString *deeplink = [params getDeepLink];
    if (deeplink) {
        NSLog(@"Deep link received: %@", deeplink);
        [self handleDeepLink:deeplink];
    }
};

// Attach user details (hashed by the SDK before it is sent)
SingularUserDetails *userDetails = [SingularUserDetails new];
[userDetails setEmail:@"user@example.com"];
[userDetails setPhoneNumber:@"+15551234567"];
config.userDetails = userDetails;

// Start the SDK
[Singular start:config];
```

--------------------------------

### Singular.start Usage Example (Swift)

Source: https://support.singular.net/hc/en-us/articles/42098675713819-iOS-SDK-Methods-Reference?navigation_side_bar=true

Swift example showing how to create a SingularConfig, set custom user ID and session timeout, and call Singular.start.

```swift
// Create configuration object
let config = SingularConfig(apiKey: "SDK_KEY", andSecret: "SDK_SECRET")

// Configure additional options if needed
config.customUserId = "user-123456"
config.sessionTimeout = 60

// Initialize the SDK
Singular.start(config)
```

--------------------------------

### Install Flutter dependencies with flutter packages get

Source: https://support.singular.net/hc/en-us/articles/4408894547227-Flutter-SDK-Basic-Integration

Run this command in your project directory to install the dependencies declared in pubspec.yaml.

```bash
flutter packages get

```

--------------------------------

### GET Reporting Request (JSON)

Source: https://support.singular.net/hc/en-us/articles/360021157251-Integrating-with-Singular-Analytics-via-API-Partners?navigation_side_bar=true

Example GET request to the reporting endpoint with the format parameter set to JSON, requesting the response in JSON format.

```xml
https:///api.examplepartner.com/api/v2.0/reporting/4ru34ur3u4u5i3pteqrt?start_date=2022-01-01&end_date=2022-04-01&format=JSON
```

--------------------------------

### Complete Configuration Example

Source: https://support.singular.net/hc/en-us/articles/37155265071259-Cordova-SDK-Configuration-Methods-Reference

A comprehensive example showing how to configure the Singular SDK with multiple options, including custom user ID, session timeout, logging, deep link handling, conversion value updates, global properties, and short link resolve timeout.

```APIDOC
## Complete Configuration Example

### Description
A comprehensive example showing how to configure the Singular SDK with multiple options.

### Usage Example
```javascript
var Singular = cordova.plugins.SingularCordovaSdk;
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

// Create configuration with API key and secret
var config = new SingularConfig('YOUR_API_KEY', 'YOUR_SECRET')
  .withCustomUserId('user123456')
  .withSessionTimeoutInSec(120)
  .withLoggingEnabled()
  .withSingularLink(function(params) {
    console.log('Deep link:', params.deeplink);
  })
  .withConversionValueUpdatedHandler(function(value) {
    console.log('Conversion value:', value);
  })
  .withGlobalProperty('user_tier', 'premium', true)
  .withGlobalProperty('app_version', '2.1.0', true)
  .withShortLinkResolveTimeout(15);

// Initialize the SDK
Singular.init(config);
```
```

--------------------------------

### Complete Configuration Example

Source: https://support.singular.net/hc/en-us/articles/36953086405147-React-Native-SDK-Configuration-Methods-Reference?navigation_side_bar=true

A complete example showing how to configure the Singular React Native SDK with all available configuration methods.

```APIDOC
## Complete Configuration Example

### Description
A complete example showing how to configure the Singular React Native SDK with all available configuration methods.

### Method
Configuration example

### Request Example
```javascript
import { Singular, SingularConfig } from 'singular-react-native';

const config = new SingularConfig('SDK_KEY', 'SDK_SECRET');
config.skAdNetworkEnabled = true;
config.userDetails = { userId: 'user123' };
config.waitForTrackingAuthorizationWithTimeoutInterval(30);

Singular.init(config);
```

### Response
No response value. This is a configuration example.
```

--------------------------------

### Run flutter pub get

Source: https://support.singular.net/hc/en-us/articles/37278069241755-Flutter-SDK-Supporting-SKAdNetwork?navigation_side_bar=true

Command to install the added dependencies.

```bash
flutter pub get
```

--------------------------------

### Complete Configuration Example

Source: https://support.singular.net/hc/en-us/articles/36953086405147-React-Native-SDK-Configuration-Methods-Reference

Demonstrates how to create a comprehensive SDK configuration by chaining multiple configuration methods together, including basic options, user identification, global properties, privacy settings, email attribution, Facebook integration, SKAdNetwork, push notifications, and branded domains.

```APIDOC
## Complete Configuration Example

### Description
Demonstrates how to create a comprehensive SDK configuration by chaining multiple configuration methods together.

### Usage Example

#### New Architecture (TurboModule direct API, React Native 0.76+)
```typescript
import NativeSingular from 'singular-react-native/js/NativeSingular';
import type { SingularConfig } from 'singular-react-native/js/NativeSingular';
import { NativeEventEmitter } from 'react-native';

// Create comprehensive configuration
const config: SingularConfig = {
  apikey: 'YOUR_API_KEY',
  secret: 'YOUR_SECRET',

  // Basic options
  sessionTimeout: 120,
  enableLogging: true,

  // User identification
  customUserId: 'user123456',

  // Global properties
  globalProperties: {
    app_version: {
      Key: 'app_version',
      Value: '1.2.3',
      OverrideExisting: true
    },
    user_type: {
      Key: 'user_type',
      Value: 'premium',
      OverrideExisting: true
    }
  },

  // Privacy settings
  limitDataSharing: false,

  // Email attribution
  espDomains: ['mailchimp.com', 'sendgrid.net'],

  // Facebook integration
  facebookAppId: 'YOUR_FACEBOOK_APP_ID',

  // SKAdNetwork (iOS)
  skAdNetworkEnabled: true,
  waitForTrackingAuthorizationWithTimeoutInterval: 300,

  // Push notifications
  pushNotificationsLinkPaths: [
    ['data', 'deeplink'],
    ['notification', 'data', 'url']
  ],

  // Branded domains
  brandedDomains: ['yourcompany.com', 'go.yourcompany.com'],
};

// Initialize the SDK
NativeSingular.init(config);

// Use event emitter for all callbacks/handlers
const emitter = new NativeEventEmitter(NativeSingular);

// Singular Link (deep links)
emitter.addListener('SingularLinkHandler', (params) => {
  if (params.deeplink) {
    console.log('Deep link:', params.deeplink);
    // Handle deep link navigation
  }
  if (params.passthrough) {
    console.log('Passthrough data:', params.passthrough);
  }
});

// Attribution callback
emitter.addListener('DeviceAttributionCallbackHandler', (attributionData) => {
  console.log('Attribution:', attributionData);
});

// SDID callbacks (if needed)
emitter.addListener('DidSetSdidCallback', (result) => {
  console.log('SDID set:', result);
});
emitter.addListener('SdidReceivedCallback', (result) => {
  console.log('SDID received:', result);
});
```

#### Old Architecture
```javascript
import { Singular, SingularConfig } from 'singular-react-native';

// Create comprehensive configuration
const config = new SingularConfig('YOUR_API_KEY', 'YOUR_SECRET')
  // Basic options
  .withSessionTimeoutInSec(120)
  .withLoggingEnabled()
  
  // User identification
  .withCustomUserId('user123456')
  
  // Global properties
  .withGlobalProperty('app_version', '1.2.3', true)
  .withGlobalProperty('user_type', 'premium', true)
  
  // Deep links
  .withSingularLink((params) => {
    if (params.deeplink) {
      console.log('Deep link:', params.deeplink);
      // Handle deep link navigation
    }
  })
  .withShortLinkResolveTimeout(10)
  
  // Attribution callback
  .withDeviceAttributionCallbackHandler((attributionData) => {
    console.log('Attribution:', attributionData);
  })
  
  // Privacy settings
  .withLimitDataSharing(false)
  
  // Email attribution
  .withEspDomains(['mailchimp.com', 'sendgrid.net'])
  
  // Facebook integration
  .withFacebookAppId('YOUR_FACEBOOK_APP_ID')
  
  // SKAdNetwork (iOS)
  .withSkAdNetworkEnabled(true)
  .withWaitForTrackingAuthorizationWithTimeoutInterval(30)
  
  // Push notifications
  .withPushNotificationsLinkPaths([
    ['data', 'deeplink'],
    ['notification', 'data', 'url']
  ])
  
  // Branded domains
  .withBrandedDomains(['yourcompany.com', 'go.yourcompany.com']);

// Initialize the SDK
Singular.init(config);
```
```

--------------------------------

### Complete Configuration Example

Source: https://support.singular.net/hc/en-us/articles/37156831120411-Flutter-SDK-Configuration-Methods-Reference?navigation_side_bar=true

A comprehensive example showing how to configure the Singular SDK with multiple options for a Flutter application.

```APIDOC
## Complete Configuration Example

### Description
Below is a comprehensive example showing how to configure the Singular SDK with multiple options for a Flutter application.

### Code
Dart
```php
import 'package:flutter/material.dart';
import 'package:singular_flutter_sdk/singular.dart';
import 'package:singular_flutter_sdk/singular_config.dart';
import 'package:singular_flutter_sdk/singular_link_params.dart';
import 'package:singular_flutter_sdk/singular_global_property.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  @override
  void initState() {
    super.initState();
    initSingularSDK();
  }

  void initSingularSDK() {
    // Create configuration object
    SingularConfig config = SingularConfig(
      'YOUR_API_KEY',
      'YOUR_SECRET_KEY'
    );

    // Enable logging for debugging
    config.enableLogging = true;
    config.logLevel = 4;

    // Set custom user ID if available
    config.customUserId = 'user_12345';

    // Configure session timeout
    config.sessionTimeout = 60.0;

    // Enable clipboard attribution
    config.clipboardAttribution = true;

    // Configure SKAdNetwork (iOS)
    config.skAdNetworkEnabled = true;
    config.manualSkanConversionManagement = false;
    config.waitForTrackingAuthorizationWithTimeoutInterval = 30;

    // Set conversion value callbacks (iOS)
    config.conversionValueUpdatedCallback = (int conversionValue) {
      print('SKAdNetwork conversion value updated: $conversionValue');
    };

    config.conversionValuesUpdatedCallback = (int cv, int coarse, bool lock) {
      print('SKAdNetwork values - Fine: $cv, Coarse: $coarse, Lock: $lock');
    };

    // Configure deep link handling
    config.singularLinksHandler = (SingularLinkParams params) {
      print('Singular Link detected');
      print('Deep link: ${params.deeplink}');
      print('Passthrough params: ${params.passthrough}');
      print('Is deferred: ${params.isDeferred}');

      // Handle deep link navigation
      if (params.deeplink != null) {
        // Navigate to appropriate screen based on deep link
      }
    };

    // Set short link timeout
    config.shortLinkResolveTimeOut = 10.0;

    // Configure attribution callback
    config.deviceAttributionCallback = (Map<String, dynamic> attributes) {
      print('Attribution data received:');
      attributes.forEach((key, value) {
        print('  $key: $value');
      });
    };

    // Configure SDID callbacks
    config.sdidReceivedCallback = (String sdid) {
      print('SDID received: $sdid');
    };

    config.didSetSdidCallback = (String sdid) {
      print('SDID has been set: $sdid');
    };

    // Set global properties
    config.globalProperties = [
      SingularGlobalProperty('app_version', '2.5.0', true),
      SingularGlobalProperty('user_tier', 'premium', false),
      SingularGlobalProperty('environment', 'production', true)
    ];

    // Configure Facebook integration
    config.facebookAppId = '1234567890123456';

    // Privacy settings
    config.limitDataSharing = false;
    config.limitAdvertisingIdentifiers = false;

    // Android-specific settings
    config.collectOAID = true;

    // Enable On-Device Matching
    config.enableOdmWithTimeoutInterval = 5;

    // Start the SDK
    Singular.start(config);

    print('Singular SDK initialized successfully');
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Singular Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: Scaffold(
        appBar: AppBar(
          title: Text('Singular SDK Demo'),
        ),
        body: Center(
          child: Text('Singular SDK Initialized'),
        ),
      ),
    );
  }
}
```

```

--------------------------------

### Sample output for Get Report Status

Source: https://support.singular.net/hc/en-us/articles/8657996894619-Reporting-API-for-Singular-Partners-and-Agencies

Example JSON response from the Get Report Status endpoint showing a successful report with status DONE and a download URL.

```json
{
  "status": 0,
  "substatus": 0,
  "value": {
    "status": "DONE",
    "url_expires_in": 3600,
    "generated_url_time_in_utc": "2018-05-13T08:26:18.457690+00:00",
    "url_expired_time_in_utc": "2018-05-13T09:26:18.457690+00:00",
    "download_url": "https://singular-reports-results.s3.amazonaws.com/singular/xxxxxxxxx",
    "report_id": "5cfdb747dd45be9691f"
  }
}
```

--------------------------------

### CSV Response Example

Source: https://support.singular.net/hc/en-us/articles/360021157251-Integrating-with-Singular-Analytics-via-API-Partners?navigation_side_bar=true

Example CSV response from the reporting API. The response includes headers and data rows for campaigns, with metrics like Impressions, Clicks, Installs, and Cost.

```xml
Date,campaign_name,site_public_id,os,creative_name,creative_id,creative_url,Impressions,Clicks,Installs,Cost2022-01-01,Fresh Air iOS Campaign (US),1195648107,iOS,interstitial,3,http://examplepartner.com/interstitials4.jpg,292088,11244,238,166.6 2022-01-01,Fresh Air iOS Campaign (US),1195648107,iOS,banner,2,http://examplepartner.com/banner2.jpg,16444743,86716,4366,3056.2 2022-01-01,Fresh Air iOS Campaign (US),1195648107,iOS,banner,1,http://examplepartner.com/banner1.jpg, 802797,40263,1800,3960.0 2022-01-01,Fresh Air iOS Campaign (US),1195648107,iOS,video,3,http://examplepartner.com/video3.jpg,398590,17107,763,2479.75 2022-01-01,Fresh Air iOS Campaign (US),1195648107,iOS,banner,4,http://examplepartner.com/banner4.jpg,423573,15429,454,317.8 2022-01-02,Fresh Air iOS Campaign (US),1195648107,iOS,interstitial,2,http://examplepartner.com/interstitials2.jpg,1425602,69436,2771,6096.2 
```

--------------------------------

### Complete SDK initialization with all configuration options

Source: https://support.singular.net/hc/en-us/articles/42349026612379-Unreal-Engine-SDK-Configuration-Methods-Reference

Initializes the Singular SDK with all configuration parameters set. Logs success or failure using UE_LOG. Requires valid API key and secret.

```cpp
// Complete configuration example
FString ApiKey = TEXT("SDK KEY");
FString ApiSecret = TEXT("SDK SECRET");
int SessionTimeout = 60;
FString CustomUserId = TEXT("user_12345");
bool SkAdNetworkEnabled = true;
bool ManualSkanConversionManagement = false;
int WaitForTrackingAuthorizationTimeout = 300;
bool OaidCollection = false;
bool EnableLogging = true;
int LogLevel = 3;
bool ClipboardAttribution = true;
FString FacebookAppId = TEXT("123456789012345");
FString CustomSdid = TEXT("");

bool Success = USingularSDKBPLibrary::Initialize(
    ApiKey,
    ApiSecret,
    SessionTimeout,
    CustomUserId,
    SkAdNetworkEnabled,
    ManualSkanConversionManagement,
    WaitForTrackingAuthorizationTimeout,
    OaidCollection,
    EnableLogging,
    LogLevel,
    ClipboardAttribution,
    FacebookAppId,
    CustomSdid
);

if (Success)
{
    UE_LOG(LogTemp, Log, TEXT("Singular SDK initialized with full configuration"));
}
else
{
    UE_LOG(LogTemp, Error, TEXT("Failed to initialize Singular SDK"));
}
```

--------------------------------

### GET Reporting Request (CSV)

Source: https://support.singular.net/hc/en-us/articles/360021157251-Integrating-with-Singular-Analytics-via-API-Partners?navigation_side_bar=true

Example GET request to the reporting endpoint without a format parameter, returning CSV by default. The URL includes query parameters for start_date and end_date.

```xml
https:///api.examplepartner.com/api/v2.0/reporting/4ru34ur3u4u5i3pteqrt?start_date=2022-01-01&end_date=2022-04-01 
```

--------------------------------

### Complete SDK Configuration Example (Swift)

Source: https://support.singular.net/hc/en-us/articles/42098616285339-iOS-SDK-Configuration-Methods-Reference?navigation_side_bar=true

Creates a SingularConfig with API credentials, sets basic options, global properties, SKAdNetwork settings, deep link handling, attribution callback, user details, and starts the SDK. The attribution callback fires on a background queue. User details are hashed by the SDK before being sent.

```swift
// Create configuration with API credentials
let config = SingularConfig(apiKey: "SDK KEY", andSecret: "YOUR_SECRET")

// Set basic options
config.waitForTrackingAuthorizationWithTimeoutInterval = 60
config.clipboardAttribution = true

// Set global properties
config.setGlobalProperty("app_version", 
                         withValue: "1.2.3", 
                         overrideExisting: true)
config.setGlobalProperty("user_type", 
                         withValue: "premium", 
                         overrideExisting: true)

// Configure SKAdNetwork
config.skAdNetworkEnabled = true
config.manualSkanConversionManagement = false
config.conversionValueUpdatedCallback = { conversionValue in
    print("Conversion value updated: \(conversionValue)")
}

// Configure deep links
config.launchOptions = launchOptions
config.singularLinksHandler = { params in
    if let deeplink = params?.getDeepLink() {
        print("Deep link received: \(deeplink)")
        self.handleDeepLink(deeplink)
    }
}

// Configure attribution callback (fires on a background queue)
config.deviceAttributionCallback = { attributionData in
    print("Attribution data: \(attributionData ?? [:])")
}

// Attach user details (hashed by the SDK before it is sent)
let userDetails = SingularUserDetails()
userDetails.setEmail("user@example.com")
userDetails.setPhoneNumber("+15551234567")
config.userDetails = userDetails

// Start the SDK
Singular.start(config)
```

--------------------------------

### Complete Configuration Example

Source: https://support.singular.net/hc/en-us/articles/37156831120411-Flutter-SDK-Configuration-Methods-Reference?navigation_side_bar=true

A comprehensive example showing how to configure the Singular Flutter SDK with all available configuration methods.

```APIDOC
## Complete Configuration Example

### Description
A complete example demonstrating the configuration of the Singular Flutter SDK using all available configuration methods.

### Methods
- clipboardAttribution
- collectOAID
- conversionValueUpdatedCallback
- conversionValuesUpdatedCallback
- customSdid
- customUserId
- deviceAttributionCallback
- didSetSdidCallback
- enableLogging
- enableOdmWithTimeoutInterval
- espDomains
- facebookAppId
- globalProperties
- imei
- limitAdvertisingIdentifiers
- limitDataSharing
- logLevel
- manualSkanConversionManagement
- pushNotificationsLinkPaths
- sdidReceivedCallback
- sessionTimeout
- shortLinkResolveTimeOut
- singularLinksHandler
- skAdNetworkEnabled
- userDetails
- waitForTrackingAuthorizationWithTimeoutInterval

### Usage
Refer to the individual method documentation for details on each configuration option.
```

--------------------------------

### Sample JSON output for Get Apps endpoint

Source: https://support.singular.net/hc/en-us/articles/12506867638939-Singular-Links-Tracking-Links-API

Example response from the Get Apps endpoint, showing an array of app sites with fields such as app_site_id, app_platform, app_store_url, site_public_id, app_id, and app.

```json
{
  'available_apps': [
    {
      'app_site_id': <...>,
      'app_platform': 'ios',
      'app_store_url': 'https://itunes.apple.com/us/app/…',
      'site_public_id': '<...>',
      'app_id': <...>,
      'app': 'My App'
    },
    {
      'app_site_id': <...>,
      'app_platform': 'android',
      'app_store_url': 'https://play.google.com/store/apps/details?id=...',
      'site_public_id': 'com.rovio.baba',
      'app_id': <...>,
      'app': 'My App'
    }
  ]
}
```

--------------------------------

### init Usage Example (Java)

Source: https://support.singular.net/hc/en-us/articles/37157391877019-Android-SDK-Methods-Reference

Java example showing simple initialization with API key and secret, and initialization with a SingularConfig object that sets a custom user ID and session timeout.

```java
// Simple initialization with API key and secret
Singular.init(context, "SDK KEY", "YOUR_SECRET");

// Initialize with configuration object
SingularConfig config = new SingularConfig("SDK KEY", "YOUR_SECRET")
    .withCustomUserId("user_123456")
    .withSessionTimeoutInSec(60);

Singular.init(context, config);
```

--------------------------------

### Verify Payload in Start Session

Source: https://support.singular.net/hc/en-us/articles/35427027157275-Android-SDK-Supporting-Push-Notifications?navigation_side_bar=true

Example start session API call showing the push notification payload under the `singular_link` parameter. Use this to confirm that push notification links are correctly passed to Singular.

```bash
https://sdk-api-v1.singular.net/api/v1/start?
a=<SDK-Key>
&singular_link=https://singularassist.sng.link/C4nw9/r1m0?_dl=singular://test&_smtype=3
&i=net.singular.singularsampleapp
&s=1740905574084
&sdk=Singular/v12.6.2
```

--------------------------------

### Complete Example with Download Button

Source: https://support.singular.net/hc/en-us/articles/19147380039579-PC-Console-Game-Integration-Guide

Initializes the Singular Web SDK and handles a download button click to retrieve the Match ID, append it as a query parameter, and redirect to the download page.

```javascript
// Initialize Web SDK
const config = new SingularConfig(sdkKey, sdkSecret, productId)
  .withInitFinishedCallback(() => {
    console.log('Singular SDK initialized');
  });

singularSdk.init(config);

// Handle download button click
document.getElementById('download-button').addEventListener('click', function() {
  // Get Match ID before redirecting to download
  const matchId = window.singularSdk.getMatchID();

  // Pass Match ID to download page via query parameter
  const downloadUrl = `https://example.com/download?match_id=${matchId}`;

  // Redirect to download page
  window.location.href = downloadUrl;
});
```
Tokens:
Raw