Shorten a link
Authorizations:
bearerAuth
Request Body schema: application/json
Info of the link to shorten
| url required | string URL to shorten |
| team required | integer Team ID (displayed on dashboard) |
| folder | integer Folder ID (displayed on dashboard) |
| code | string^[a-zA-Z0-9!-]{3,50}$ Custom short code |
| label | string Label |
| password | string Password |
| expired_at | string Expiration date |
Responses
Request samples
- Payload
Content type
application/json
{- "url": "string",
- "team": 0,
- "folder": 0,
- "code": "xxxxx",
- "label": "string",
- "password": "string",
- "expired_at": "string"
}Response samples
- 200
- 404
Content type
application/json
{- "id": 0,
- "url": "string",
- "expired_at": "string",
- "team": 0,
- "folder": 0,
- "url_code": "xxxxx",
- "domain": "urlr.me",
- "label": "string",
- "newId": "c20e556b-6817-44ba-b916-0bc30059d4f0",
- "code": 200
}Get statistics of a link
Authorizations:
bearerAuth
Request Body schema: application/json
Infos to provide to get statistics of a link
| code required | string^[a-zA-Z0-9!-]{3,50}$ The short code of the URL |
| folder | integer Folder ID (displayed on dashboard). Required for a link associated with a folder with a domain. |
| from | string Get stats from this date |
| to | string Get stats until this date |
| includeBots | boolean Default: false Whether include bots or not in statistics |
Responses
Request samples
- Payload
Content type
application/json
{- "code": "xxxxx",
- "folder": 0,
- "from": "dd/mm/yyyy",
- "to": "dd/mm/yyyy",
- "includeBots": false
}Response samples
- 200
- 400
Content type
application/json
{- "code": 200,
- "clicks": 32,
- "uniqueClicks": 51,
- "linkId": "009f739c-6620-43b0-978e-b245e723c57a"
}