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

NameTypeRequiredMaxDescription
pagenumberNo-Page number for pagination (defaults to 1)

Response

NameTypeDescription
dataarrayArray of URL shortener objects, max 20 items are returned
data[].urlstringThe original URL that was shortened
data[].shortUrlstringThe generated short URL that redirects to the original URL
data[].clicksnumberThe number of times the short URL has been clicked
metadataobjectMetadata about the URL shortener list request
metadata.costnumberThe cost of the URL shortener list request

Errors

{
  "error": "string", 
  "code": "string"
}
HTTP StatusError CodeMessage
400INVALID_PAYLOADOccurs when the payload is invalid.
400INVALID_REQUESTThe request is invalid or contains an invalid parameter.
400UTILS_URL_SHORTNER_ERRORError during URL shortener list retrieval.
400INSUFFICIENT_BALANCEThe user has insufficient balance to perform this operation.
401UNAUTHORIZEDThe token is invalid or missing.
429TOO_MANY_REQUESTSThe request limit has been reached.