Skip to main content

​
1. Prerequisites

To follow this guide, you will need to:

​
2. Install and initialize the Pearset Python SDK

1

Install

To install the Pearset Python SDK, run the following command:
pip
pip install pearset
2

Initialize

Initialize the Pearset Python SDK by creating a new instance of the Pearset class.
import os
import pearset
from pearset.models import operations

d = pearset.Pearset(
  token=os.environ['DUB_API_KEY'],
)
Let’s create a short link using the Pearset Python SDK.
index.py
res = d.links.create(request={
  "url": "https://google.com",
})

print(res.short_link)
This will let you easily update the link or retrieve analytics for it later on using the externalId instead of the Pearset linkId.
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.
index.py
res = d.links.create(request={
  "url": "https://google.com",
  "external_id": "12345",
})

print(res.short_link)
Pearset Python 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.
index.py
res = d.links.upsert(request={
  "url": "https://google.com",
})

print(res.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 Python 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_).
index.py
# Update a link by its linkId
res = d.links.update(link_id="clx1gvi9o0005hf5momm6f7hj", request_body={
  "url": "https://google.uk",
})

print(res.short_link)

# Update a link by its externalId
res = d.links.update(external_id="ext_12345", request_body={
  "url": "https://google.uk",
})

print(res.short_link)
Pearset allows you to retrieve analytics for a link using the Pearset Python SDK.
index.py
# Retrieve the timeseries analytics for the last 7 days for a link
res = d.analytics.retrieve(request={
  "link_id": "clx1gvi9o0005hf5momm6f7hj",
  "interval": "7d",
  "group_by": "timeseries",
})

print(res)
Similarly, you can retrieve analytics for a link using the externalId field.
index.py
# Retrieve the timeseries analytics for the last 7 days for a link
res = d.analytics.retrieve(request={
  "external_id": "ext_12345",
  "interval": "7d",
  "group_by": "timeseries",
})

print(res)

​
7. Examples

Python Example

See the full example on GitHub.