dub (EXPERIMENTAL) #

Dub is link management infrastructure for companies to create marketing campaigns, link sharing features, and referral programs.

• API version: 0.0.1

For more information, please visit https://dub.co/api

Installation & Usage #

pub.dev #

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  dub: 0.0.1

Github #

To use this package from Github, please include the following in pubspec.yaml

dependencies:
  dub:
    git:
      url: https://github.com/thealphamerc/dub-dart.git
      #ref: main

Local development #

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  dub:
    path: /path/to/dub

Getting Started #

Please follow the installation procedure and then run the following:

import 'package:dub/dub.dart';


final api = Dub().getAnalyticsApi();
final String workspaceId = "ws_cluuwcv0r..."; // String | The ID of the workspace.
final String projectSlug = "projectSlug_example"; // String | The slug of the project. This field is deprecated – use `workspaceId` instead.
final String domain = "domain_example"; // String | The domain of the short link.
final String key = "key_example"; // String | The short link slug.
final String linkId = "linkId_example"; // String | The unique ID of the short link on Dub.
final String externalId = "externalId_example"; // String | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.
final String interval = "interval_example"; // String | The interval to retrieve analytics for.
final String country = "country_example"; // String | The country to retrieve analytics for.
final String city = "city_example"; // String | The city to retrieve analytics for.
final String device = "device_example"; // String | The device to retrieve analytics for.
final String browser = "browser_example"; // String | The browser to retrieve analytics for.
final String os = "os_example"; // String | The OS to retrieve analytics for.
final String referer = "referer_example"; // String | The referer to retrieve analytics for.
final String url = "url_example"; // String | The URL to retrieve analytics for.
final String tagId = "tagId_example"; // String | The tag ID to retrieve analytics for.
final bool qr = true; // bool | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
final bool root = true; // bool | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.

try {
    final response = await api.getBrowserAnalytics(workspaceId, projectSlug, domain, key, linkId, externalId, interval, country, city, device, browser, os, referer, url, tagId, qr, root);
    print(response);
} catch on DioException (e) {
    print("Exception when calling AnalyticsApi->getBrowserAnalytics: $e\n");
}

Documentation for API Endpoints #

All URIs are relative to https://api.dub.co

Documentation For Models #

• AddDomainRequest
• CreateLinkRequest
• CreateLinkRequestGeo
• CreateTagRequest
• CreateWorkspaceRequest
• DeleteDomain200Response
• DeleteLink200Response
• DomainSchema
• EditDomainRequest
• GetBrowserAnalytics200ResponseInner
• GetCityAnalytics200ResponseInner
• GetCountryAnalytics200ResponseInner
• GetDeviceAnalytics200ResponseInner
• GetLinks400Response
• GetLinks400ResponseError
• GetLinks401Response
• GetLinks401ResponseError
• GetLinks403Response
• GetLinks403ResponseError
• GetLinks404Response
• GetLinks404ResponseError
• GetLinks409Response
• GetLinks409ResponseError
• GetLinks410Response
• GetLinks410ResponseError
• GetLinks422Response
• GetLinks422ResponseError
• GetLinks429Response
• GetLinks429ResponseError
• GetLinks500Response
• GetLinks500ResponseError
• GetMetatags200Response
• GetOSAnalytics200ResponseInner
• GetRefererAnalytics200ResponseInner
• GetTimeseriesAnalytics200ResponseInner
• GetTopLinks200ResponseInner
• GetTopURLs200ResponseInner
• LinkSchema
• LinkSchemaGeo
• TagSchema
• TransferDomainRequest
• WorkspaceSchema
• WorkspaceSchemaDomainsInner
• WorkspaceSchemaUsersInner

Documentation For Authorization #

Authentication schemes defined for the API:

token #

• Type: HTTP Bearer Token authentication

Author #

support@dub.co