URL Shortener List
Retrieve a list of all shortened URLs in your account. This service allows you to view your shortened URLs along with their original URLs and click statistics.
Endpoint
List all shortened URLs in your account
GEThttps://api.xtartapp.com/utils/url-shortner
*Authentication
You must use a Bearer token provided by the dashboard to use for authentication. Add the token to the Authorization header.
Request body
Name | Type | Required | Max | Description |
---|---|---|---|---|
page | number | No | - | Page number for pagination (defaults to 1) |
Response
Name | Type | Description |
---|---|---|
data | array | Array of URL shortener objects, max 20 items are returned |
data[].url | string | The original URL that was shortened |
data[].shortUrl | string | The generated short URL that redirects to the original URL |
data[].clicks | number | The number of times the short URL has been clicked |
metadata | object | Metadata about the URL shortener list request |
metadata.cost | number | The cost of the URL shortener list request |
Errors
{
"error": "string",
"code": "string"
}
HTTP Status | Error Code | Message |
---|---|---|
400 | INVALID_PAYLOAD | Occurs when the payload is invalid. |
400 | INVALID_REQUEST | The request is invalid or contains an invalid parameter. |
400 | UTILS_URL_SHORTNER_ERROR | Error during URL shortener list retrieval. |
400 | INSUFFICIENT_BALANCE | The user has insufficient balance to perform this operation. |
401 | UNAUTHORIZED | The token is invalid or missing. |
429 | TOO_MANY_REQUESTS | The request limit has been reached. |