mirror of https://github.com/LukeHagar/dub-node.git synced 2025-12-06 04:19:37 +00:00

Files

github-actions[bot] 7439bf1f74 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.252.0 (#76 )

Co-authored-by: speakeasybot <bot@speakeasyapi.dev>

2024-04-14 11:33:42 +05:30

51 KiB

Raw Blame History

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: "<YOUR_BEARER_TOKEN_HERE>",
  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<number>

Errors

Error Object	Status Code	Content Type
errors.BadRequest	400	application/json
errors.Unauthorized	401	application/json
errors.Forbidden	403	application/json
errors.NotFound	404	application/json
errors.Conflict	409	application/json
errors.InviteExpired	410	application/json
errors.UnprocessableEntity	422	application/json
errors.RateLimitExceeded	429	application/json
errors.InternalServerError	500	application/json
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: "<YOUR_BEARER_TOKEN_HERE>",
  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.ResponseBody[]>

Errors

Error Object	Status Code	Content Type
errors.BadRequest	400	application/json
errors.Unauthorized	401	application/json
errors.Forbidden	403	application/json
errors.NotFound	404	application/json
errors.Conflict	409	application/json
errors.InviteExpired	410	application/json
errors.UnprocessableEntity	422	application/json
errors.RateLimitExceeded	429	application/json
errors.InternalServerError	500	application/json
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: "<YOUR_BEARER_TOKEN_HERE>",
  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.GetCountryAnalyticsResponseBody[]>

Errors

Error Object	Status Code	Content Type
errors.BadRequest	400	application/json
errors.Unauthorized	401	application/json
errors.Forbidden	403	application/json
errors.NotFound	404	application/json
errors.Conflict	409	application/json
errors.InviteExpired	410	application/json
errors.UnprocessableEntity	422	application/json
errors.RateLimitExceeded	429	application/json
errors.InternalServerError	500	application/json
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: "<YOUR_BEARER_TOKEN_HERE>",
  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.GetCityAnalyticsResponseBody[]>

Errors

Error Object	Status Code	Content Type
errors.BadRequest	400	application/json
errors.Unauthorized	401	application/json
errors.Forbidden	403	application/json
errors.NotFound	404	application/json
errors.Conflict	409	application/json
errors.InviteExpired	410	application/json
errors.UnprocessableEntity	422	application/json
errors.RateLimitExceeded	429	application/json
errors.InternalServerError	500	application/json
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: "<YOUR_BEARER_TOKEN_HERE>",
  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.GetDeviceAnalyticsResponseBody[]>

Errors

Error Object	Status Code	Content Type
errors.BadRequest	400	application/json
errors.Unauthorized	401	application/json
errors.Forbidden	403	application/json
errors.NotFound	404	application/json
errors.Conflict	409	application/json
errors.InviteExpired	410	application/json
errors.UnprocessableEntity	422	application/json
errors.RateLimitExceeded	429	application/json
errors.InternalServerError	500	application/json
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: "<YOUR_BEARER_TOKEN_HERE>",
  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.GetBrowserAnalyticsResponseBody[]>

Errors

Error Object	Status Code	Content Type
errors.BadRequest	400	application/json
errors.Unauthorized	401	application/json
errors.Forbidden	403	application/json
errors.NotFound	404	application/json
errors.Conflict	409	application/json
errors.InviteExpired	410	application/json
errors.UnprocessableEntity	422	application/json
errors.RateLimitExceeded	429	application/json
errors.InternalServerError	500	application/json
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: "<YOUR_BEARER_TOKEN_HERE>",
  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.GetOSAnalyticsResponseBody[]>

Errors

Error Object	Status Code	Content Type
errors.BadRequest	400	application/json
errors.Unauthorized	401	application/json
errors.Forbidden	403	application/json
errors.NotFound	404	application/json
errors.Conflict	409	application/json
errors.InviteExpired	410	application/json
errors.UnprocessableEntity	422	application/json
errors.RateLimitExceeded	429	application/json
errors.InternalServerError	500	application/json
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: "<YOUR_BEARER_TOKEN_HERE>",
  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.GetRefererAnalyticsResponseBody[]>

Errors

Error Object	Status Code	Content Type
errors.BadRequest	400	application/json
errors.Unauthorized	401	application/json
errors.Forbidden	403	application/json
errors.NotFound	404	application/json
errors.Conflict	409	application/json
errors.InviteExpired	410	application/json
errors.UnprocessableEntity	422	application/json
errors.RateLimitExceeded	429	application/json
errors.InternalServerError	500	application/json
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: "<YOUR_BEARER_TOKEN_HERE>",
  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.GetTopLinksResponseBody[]>

Errors

Error Object	Status Code	Content Type
errors.BadRequest	400	application/json
errors.Unauthorized	401	application/json
errors.Forbidden	403	application/json
errors.NotFound	404	application/json
errors.Conflict	409	application/json
errors.InviteExpired	410	application/json
errors.UnprocessableEntity	422	application/json
errors.RateLimitExceeded	429	application/json
errors.InternalServerError	500	application/json
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: "<YOUR_BEARER_TOKEN_HERE>",
  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.GetTopURLsResponseBody[]>

Errors

Error Object	Status Code	Content Type
errors.BadRequest	400	application/json
errors.Unauthorized	401	application/json
errors.Forbidden	403	application/json
errors.NotFound	404	application/json
errors.Conflict	409	application/json
errors.InviteExpired	410	application/json
errors.UnprocessableEntity	422	application/json
errors.RateLimitExceeded	429	application/json
errors.InternalServerError	500	application/json
errors.SDKError	4xx-5xx	/

51 KiB Raw Blame History Unescape Escape

Analytics

Available Operations

clicks

Example Usage

Parameters

Response

Errors

timeseries

Example Usage

Parameters

Response

Errors

countries

Example Usage

Parameters

Response

Errors

cities

Example Usage

Parameters

Response

Errors

devices

Example Usage

Parameters

Response

Errors

browsers

Example Usage

Parameters

Response

Errors

os

Example Usage

Parameters

Response

Errors

referers

Example Usage

Parameters

Response

Errors

topLinks

Example Usage

Parameters

Response

Errors

topUrls

Example Usage

Parameters

Response

Errors

51 KiB

Raw Blame History