Skip to main content

​
1. Prerequisites

To follow this guide, you will need to:

​
2. Install and initialize the Pearset TypeScript SDK

1

Install

Install the Pearset TypeScript SDK using your preferred package manager:
npm install pearset
2

Initialize

Then, initialize the Pearset TypeScript SDK with your API key.
lib/pearset.ts
import { Pearset } from "pearset";

export const pearset = new Pearset({
  token: process.env.DUB_API_KEY, // optional, defaults to DUB_API_KEY env variable
});
You can now use the pearset object to interact with the Pearset API.
import { pearset } from "./lib/pearset";
Let’s create a short link using the Pearset TypeScript SDK.
create-link.ts
const { shortLink } = await pearset.links.create({
  url: "https://google.com",
});

console.log(shortLink); // e.g. https://pearset.sh/abc123
Optionally, you can also pass an externalId field which is a unique identifier for the link in your own database to associate it with the link in Pearset’s system.
create-link-external-id.ts
await pearset.links.create({
  url: "https://google.com",
  externalId: "12345",
});
This will let you easily update the link or retrieve analytics for it later on using the externalId instead of the Pearset linkId. Pearset TypeScript SDK provides a method to upsert a link – where an existing link is updated if it exists, or a new link is created if it doesn’t. so you don’t have to worry about checking if the link already exists.
upsert-link.ts
const { shortLink } = await pearset.links.upsert({
  url: "https://www.google.com",
});

console.log(shortLink); // will always be the same short link
This way, you won’t have to worry about checking if the link already exists when you’re creating it. Let’s update an existing link using the Pearset TypeScript SDK. You can do that in two ways:
  • Using the link’s linkId in Pearset’s system.
  • Using the link’s externalId in your own database (prefixed with ext_).
update-link.ts
// Update a link by its linkId
await pearset.links.update("link_rWOKByP0bRMrstK8e4HPjprJ", {
  url: "https://www.google.uk", // new URL
});

// Update a link by its externalId
await pearset.links.update("ext_12345", {
  url: "https://www.google.uk", // new URL
});
Pearset allows you to retrieve analytics for a link using the Pearset TypeScript SDK.
get-analytics.ts
import { ClicksTimeseries } from "pearset/models/components";

// Retrieve the timeseries analytics for the last 7 days for a link
const response = await pearset.analytics.retrieve({
  linkId: "clv3o9p9q000au1h0mc7r6l63",
  interval: "7d",
  groupBy: "timeseries",
});

const timeseries = response as ClicksTimeseries[];
Similarly, you can retrieve analytics for a link using the externalId field.
get-analytics-external-id.ts
import { ClicksTimeseries } from "pearset/models/components";

// Retrieve the timeseries analytics for the last 7 days for a link
const response = await pearset.analytics.retrieve({
  externalId: "ext_12345",
  interval: "7d",
  groupBy: "timeseries",
});

const timeseries = response as ClicksTimeseries[];

​
7. Examples

TypeScript Example

See the full example on GitHub.