dub-node/docs/sdks/analytics/README.md

Analytics

(analytics)

Available Operations

• clicks - Retrieve clicks analytics
• timeseries - Retrieve timeseries analytics
• countries - Retrieve country analytics
• cities - Retrieve city analytics
• devices - Retrieve device analytics
• browsers - Retrieve browser analytics
• os - Retrieve OS analytics
• referers - Retrieve referer analytics
• topLinks - Retrieve top links
• topUrls - Retrieve top URLs

clicks

Retrieve the number of clicks for a link, a domain, or the authenticated workspace.

Example Usage

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
  workspaceId: "<value>",
});

async function run() {
  const result = await dub.analytics.clicks({});

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.GetClicksAnalyticsRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<operations.GetClicksAnalyticsResponse>

Errors

Error Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/

timeseries

Retrieve the number of clicks for a link, a domain, or the authenticated workspace over a period of time.

Example Usage

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
  workspaceId: "<value>",
});

async function run() {
  const result = await dub.analytics.timeseries({});

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.GetTimeseriesAnalyticsRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<operations.GetTimeseriesAnalyticsResponse>

Errors

Error Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/

countries

Retrieve the top countries by number of clicks for a link, a domain, or the authenticated workspace.

Example Usage

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
  workspaceId: "<value>",
});

async function run() {
  const result = await dub.analytics.countries({});

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.GetCountryAnalyticsRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<operations.GetCountryAnalyticsResponse>

Errors

Error Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/

cities

Retrieve the top countries by number of clicks for a link, a domain, or the authenticated workspace.

Example Usage

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
  workspaceId: "<value>",
});

async function run() {
  const result = await dub.analytics.cities({});

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.GetCityAnalyticsRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<operations.GetCityAnalyticsResponse>

Errors

Error Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/

devices

Retrieve the top devices by number of clicks for a link, a domain, or the authenticated workspace.

Example Usage

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
  workspaceId: "<value>",
});

async function run() {
  const result = await dub.analytics.devices({});

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.GetDeviceAnalyticsRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<operations.GetDeviceAnalyticsResponse>

Errors

Error Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/

browsers

Retrieve the top browsers by number of clicks for a link, a domain, or the authenticated workspace.

Example Usage

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
  workspaceId: "<value>",
});

async function run() {
  const result = await dub.analytics.browsers({});

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.GetBrowserAnalyticsRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<operations.GetBrowserAnalyticsResponse>

Errors

Error Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/

os

Retrieve the top OS by number of clicks for a link, a domain, or the authenticated workspace.

Example Usage

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
  workspaceId: "<value>",
});

async function run() {
  const result = await dub.analytics.os({});

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.GetOSAnalyticsRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<operations.GetOSAnalyticsResponse>

Errors

Error Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/

referers

Retrieve the top referers by number of clicks for a link, a domain, or the authenticated workspace.

Example Usage

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
  workspaceId: "<value>",
});

async function run() {
  const result = await dub.analytics.referers({});

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.GetRefererAnalyticsRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<operations.GetRefererAnalyticsResponse>

Errors

Error Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/

topLinks

Retrieve the top links by number of clicks for a domain or the authenticated workspace.

Example Usage

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
  workspaceId: "<value>",
});

async function run() {
  const result = await dub.analytics.topLinks({});

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.GetTopLinksRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<operations.GetTopLinksResponse>

Errors

Error Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/

topUrls

Retrieve the top URLs by number of clicks for a given short link.

Example Usage

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
  workspaceId: "<value>",
});

async function run() {
  const result = await dub.analytics.topUrls({});

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.GetTopURLsRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<operations.GetTopURLsResponse>

Errors

Error Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/