PicSee Short Link API Document

Download OpenAPI specification:

E-mail: service@picsee.vip URL: https://picsee.io Terms of Service

This is the API documentation for the PicSee URL Shortener.
PicSee offers Free, Basic, and Advanced Plans. For detailed information and documentation updates, please refer to the PicSee API official website: https://picsee.io/developers.

If you encounter issues while integrating, please use Postman to take screenshots, and provide your PicSee ID to PicSee customer support. Please DO NOT share your code directly.
The API endpoint varies when upgrading to the "Dedicated Host (獨立主機)" or "Fixed IP Server (固定 IP)" plans. Don't hesitate to get in touch with PicSee for more details.

API Plans & Pricing

(Free 800 requests / year)

View Plan

Get API Plans and Usage

One call per second is allowed. If this limit is exceeded, a status code 429 will be returned. A try-catch structure is recommended to retry.

Authorizations:

access_tokenX-API-Key

Responses

Request samples

cURL
JavaScript (fetch)
Python (requests)

curl -X 'GET' \
'https://api.pics.ee/v2/my/api/status?access_token=YOUR_ACCESS_TOKEN' \
-H 'accept: application/json'

Response samples

200
default

Content type

application/json

{"data": {"picseeId": 739,
"email": "service@picsee.vip",
"planName": "basic",
"quota": 10000,
"usage": 13,
"endTime": "2024-03-23 23:59:59",
"queryTime": "2023-11-14 11:39:00"
},
"meta": {"request": {"url": { },
"query": { }
}
}
}

Create a Short Link

As long as the request is within the plan's rate limit, you do not need to wait for the response and can make concurrent calls. If the rate limit is exceeded, a status code 429 will be returned. A try-catch structure is recommended to retry.

💡 Once a Short Link is created or edited, it can be used immediately. However, due to the cache design, it may take up to 10 minutes to appear in the "Batch Records" on the PicSee website or the Short Link List via the API.

Authorizations:

access_tokenX-API-Key

Request Body schema: application/json
required

url required	string <uri> Destination URL, the target URL of redirection, max length: 2048
encodeId	string Specify a unique short link slug for the URL. The slug must be between 3 and 90 characters in length, and can only contain English letters (A-Z, a-z), numbers (0-9), underscores (_), hyphens (-), or Chinese characters. If the slug does not meet these criteria or conflicts with an existing slug, the system will return an error. Ensure the slug is unique across the entire PicSee platform.
domain	string Specify the Short Link domain. If omitted or invalid, the default domain will be applied.
externalId	string Allows grouping of URLs with an optional custom string between 1 and 100 characters.
title	string Advanced Plan Customize the URL preview title with a string of 3-300 characters.
description	string Advanced Plan Customize the URL preview description with a string of 3-300 characters.
imageUrl	string <uri> Advanced Plan Customize the URL preview thumbnail, which must be an image URL starting with http(s).
tags	Array of strings Advanced Plan Supports up to 3 tags per short link.
	Array of objects Advanced Plan Detects the user's device to redirect to specific target pages.
fbPixel	string Advanced Plan Meta Pixel ID. Only pixels created via the web version are selectable. To add a new pixel, go to the web version settings.
gTag	string Advanced Plan Google Tag Manager (GTM) ID. Only GTMs created on the web version can be selected. To add a new GTM, go to the web version settings.
	object Advanced Plan UTM parameters, you can specify the following UTM types:
	object Advanced Plan And needs purchase of the "Path Parameterization（路徑化參數）" feature

Responses

Request samples

Payload
cURL
JavaScript (fetch)
Python (requests)

Content type

application/json

Example

Create a Short Link

{"url": "https://picsee.io"
}

Response samples

200
default

Content type

application/json

{"data": {"picseeUrl": "https://pse.is/5b93x9"
},
"meta": {"request": {"url": { },
"query": { }
}
}
}

Get Short Link Analytics

There is no call frequency limit; however, the content update frequency may vary depending on the plan.

Authorizations:

access_tokenX-API-Key

path Parameters

encodeId

required

string

Example: 5b93x9

The slug of the short link

query Parameters

format	string Enum: "json" "csv" Example: format=csv Supported return formats include "json" and "csv". If left blank, the default is "json".
dailyClicks	boolean Example: dailyClicks=false Return daily click analytics for the past 60 days. If left blank, it defaults to false (not returning daily click analytics).

Responses

Request samples

cURL
JavaScript (fetch)
Python (requests)

curl -X 'GET' \
'https://api.pics.ee/v1/links/5b93x9/overview?access_token=YOUR_ACCESS_TOKEN' \
-H 'accept: application/json'

Response samples

200
default

Content type

application/json

{"data": {"id": "22198535",
"encodeId": "5b93x9",
"url": "https://picsee.io",
"ssl": true,
"domain": "pse.is",
"totalClicks": 21,
"uniqueClicks": 9,
"created": "2023-11-11T08:06:28+08:00",
"dailyClicks": [{"date": "2023-11-13",
"uniqueClicks": 3,
"totalClicks": 5
},
{"date": "2023-11-12",
"uniqueClicks": 0,
"totalClicks": 0
},
{"date": "2023-11-11",
"uniqueClicks": 18,
"totalClicks": 20
}
]
},
"meta": {"request": {"url": { },
"query": { }
}
}
}

List of Short Links

One call per second is allowed. If this limit is exceeded, a status code 429 will be returned. A try-catch structure is recommended to retry.

Authorizations:

access_tokenX-API-Key

query Parameters

limit	number Example: limit=20 Short links displayed per list, defaulting to 20, with an optional maximum of 50.
startTime	string Example: startTime=2023-11-20T13:00:00 Set the start time for listing short links, queried in descending order from the specified time backward, defaulting to the current time.
prevMapId	number Example: prevMapId=22198535 Retrieve the list of short links older than this mapId. When both startTime and prevMapId are specified, they will be queried using an AND condition.
isAPILink	number Example: isAPILink=1 Query only API-generated short links: 1 for yes, 0 for no (includes non-API-generated links). The default is 1.
externalId	string Example: externalId=20231111_campaign Query short links containing a specific externalId.

Request Body schema: application/json
optional

Search Parameters (Advanced Plan)

tags	string Search for short links with the specified tag (limit: 3-30 characters).
encodeId	string Search for short links using the slug (requires an exact match to find results).
keyword	string Search for short links with the keyword in the title or description (limit: 3-30 characters).
url	string <uri> Search for links that exactly match the destination URL, with the format restricted to a URL.
authorId	string Search for short links created by a specific link author ID.
fbPixel	string Search for short links with a specific Meta pixel.
gTag	string Search for short links with a specific GTM.
	object Search for short links with the specified UTM parameter; if there are multiple UTM parameters, the search will return results matching all parameters.

Responses

Request samples

Payload
cURL
JavaScript (fetch)
Python (requests)

Content type

application/json

{"tags": "facebook_campaign",
"encodeId": "5b93x9",
"keyword": "picsee",
"url": "https://picsee.io",
"authorId": 739,
"fbPixel": 1234567,
"gTag": "GTM-XXXXXXX",
"utm": {"source": "linkedin",
"campaign": "hiring",
"medium": "social",
"term": "2024"
}
}

Response samples

200
default

Content type

application/json

{"data": [{"mapId": "22198535",
"domain": "pse.is",
"encodeId": "5b93x9",
"ssl": true,
"url": "https://picsee.io",
"title": "PicSee URL Shortener | Boost YouTube's Facebook game",
"description": "URL Shortener - Register-free Link shortening, Bulk Batch URL Shortener API, Customized Previews, Integrated with ChatGPT, Facebook Pixel and GTM",
"gtm": "GTM-XXXXXXX",
"fbPixel": 1234567,
"utm": {"source": "facebook",
"medium": "social",
"campaign": "2024",
"term": "0112",
"content": "UTM"
},
"createTime": "2019-08-24T14:15:22Z",
"author": {"id": 739,
"email": "service@picsee.vip",
"groupId": 119
},
"tags": [{"id": 2323031,
"value": "edm"
},
{"id": 2323032,
"value": "event1"
}
],
"targets": [{"target": "ios_android",
"url": "https://picsee.io/"
},
{"target": "pc_mac",
"url": "https://picsee.io/pricing"
}
],
"isAPILink": true,
"totalClicks": 20,
"uniqueClicks": 14,
"qrcodeUrl": "https://api.pics.ee/pse.is/5b93x9/qrcode.jpeg"
}
],
"meta": {"request": {"url": { },
"query": { }
}
}
}

Delete or Recover a Short Link

One call per second is allowed. If this limit is exceeded, a status code 429 will be returned. A try-catch structure is recommended to retry.

Authorizations:

access_tokenX-API-Key

path Parameters

encodeId

required

string

Example: 5b93x9

The short link slug to be deleted or recovered.

Request Body schema: application/json
required

value

required

string

Enum: "delete" "recover"

delete: Moves the link to the trash bin. recover: Restores the link from the trash bin.

Responses

Request samples

Payload
cURL
JavaScript (fetch)
Python (requests)

Content type

application/json

{"value": "delete"
}

Response samples

200
default

Content type

application/json

{"data": {"result": "success"
},
"meta": {"request": {"url": { },
"query": { }
}
}
}

Advanced Plan

Edit a Short link

One call per second is allowed. If this limit is exceeded, a status code 429 will be returned. A try-catch structure is recommended to retry.

💡 Once a Short Link is created or edited, it can be used immediately. However, due to the cache design, it may take up to 10 minutes to appear in the "Batch Records" on the PicSee website or the Short Link List and Short Link Analytics via the API.

Authorizations:

access_tokenX-API-Key

path Parameters

encodeId

required

string

Example: 5b93x9

The slug of the short link

Request Body schema: application/json
required

encodeId	string Specify a unique short link slug for the URL. The slug must be between 3 and 90 characters in length, and can only contain English letters (A-Z, a-z), numbers (0-9), underscores (_), hyphens (-), or Chinese characters. If the slug does not meet these criteria or conflicts with an existing slug, the system will return an error. Ensure the slug is unique across the entire PicSee platform.
domain	string Specify the Short Link domain. If omitted or invalid, the default domain will be applied.
title	string Customize the URL preview title with a string of 3-300 characters.
description	string Customize the URL preview description with a string of 3-300 characters.
imageUrl	string <uri> Customize the URL preview thumbnail, which must be an image URL starting with http(s).
url	string <uri> Destination URL, the target URL of redirection, max length: 2048
tags	Array of strings Supports up to 3 tags per short link.
	Array of objects Detects the user's device to redirect to specific target pages.
fbPixel	string Meta Pixel ID. Only pixels created via the web version are selectable. To add a new pixel, go to the web version settings.
gTag	string Google Tag Manager (GTM) ID. Only GTMs created on the web version can be selected. To add a new GTM, go to the web version settings.
	object UTM parameters, you can specify the following UTM types:
expireTime	string <date-time> The expiration time for the link, which can be set to any future date and time in the format `YYYY-MM-DDTHH:mm:ss`. Passing `null` will clear any previously set expiration.

Responses

Request samples

Payload
cURL
JavaScript (fetch)
Python (requests)

Content type

application/json

{"encodeId": "5b93x9",
"domain": "pse.is",
"title": "PicSee URL Shortener",
"description": "URL Shortener, QR Code…",
"imageUrl": "https://wcdn.pse.im/website/picsee_v3_og.png",
"url": "https://picsee.io",
"tags": ["event1",
"中文",
"1111"
],
"targets": [[{"target": "ios_android",
"url": "https://picsee.io/"
},
{"target": "pc_mac",
"url": "https://picsee.io/pricing"
}
]
],
"fbPixel": 1234567,
"gTag": "GTM-XXXXXXX",
"utm": {"source": "facebook",
"medium": "social",
"campaign": "2024",
"term": "0112",
"content": "UTM"
},
"expireTime": "2023-11-30T23:59:59"
}

Response samples

200
default

Content type

application/json

{"data": {"result": "success"
},
"meta": {"request": {"url": { },
"query": { }
}
}
}

Batch Create Short Links

You must wait for the response from the current call before making another request.

💡 Once a Short Link is created or edited, it can be used immediately. However, due to the cache design, it may take up to 10 minutes to appear in the "Batch Records" on the PicSee website or the Short Link List and Short Link Analytics via the API.

Authorizations:

access_tokenX-API-Key

Request Body schema: application/json
required

urls required	Array of strings <uri> [ items <uri > ]
domain	string Specify the Short Link domain. If omitted or invalid, the default domain will be applied.

Responses

Request samples

Payload
cURL
JavaScript (fetch)
Python (requests)

Content type

application/json

{"urls": ["https://picsee.io"
],
"domain": "pse.is"
}

Response samples

200
default

Content type

application/json

{"data": {"links": [{"originalLink": "https://picsee.io",
"picseeLink": "https://pse.is/free_api"
}
]
},
"meta": {"request": {"url": { },
"query": { }
}
}
}

Authorized Security Partners Only

Report Short Link Abuse

This API is exclusively available to authorized security partners. It enables partners to flag PicSee shortened URLs to display warning pages, preventing users from being redirected to potentially harmful destination sites.

Authorizations:

access_tokenX-API-Key

Request Body schema: application/json
required

url required	string <uri> A PicSee short link - must include protocol (e.g., https) and path (e.g., /abuse)
attack_type	string Type of attack - for internal reference
description	string Notes - for internal reference
date	string <date> Report date - for internal reference, used for report tracking
target_brand	string Target brand - for internal reference
screenshot_url	string <uri> Screenshot URL - for internal reference

Responses

Request samples

Payload
cURL
JavaScript (fetch)
Python (requests)

Content type

application/json

{"url": "https://psee.io/abuse",
"attack_type": "string",
"description": "string",
"date": "2019-08-24",
"target_brand": "string",
"screenshot_url": "http://example.com"
}

Response samples

200
default

Content type

application/json

{"data": {"status": "noted"
},
"meta": {"request": {"url": { },
"query": { }
}
}
}

PicSee Short Link API Document

Get API Plans and Usage

Authorizations:

Responses

Request samples

Response samples

Create a Short Link

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Short Link Analytics

Authorizations:

path Parameters

query Parameters

Responses

Request samples

Response samples

List of Short Links

Authorizations:

query Parameters

Request Body schema: application/jsonoptional

Search Parameters (Advanced Plan)

Responses

Request samples

Response samples

Delete or Recover a Short Link

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Advanced Plan

Edit a Short link

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Batch Create Short Links

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Authorized Security Partners Only

Report Short Link Abuse

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
optional

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required