API Endpoint #
Get Today’s Total Clicks #
Endpoint: GET /api/user/v1/today_total_clicks
cURL Command:
Request Example #
curl --location --request GET 'https://apiv2.foxlyme.com/api/user/v1/today_total_clicks'
Query Parameters #
- page (optional):
Number
Page number for pagination. - limit (optional):
Number
Number of results per page. - sortBy (optional):
String
Sort results by specified criteria:popular
: URLs with the highest clicks.newest
: Most recently added URLs.oldest
: Oldest URLs.least_popular
: URLs with the fewest clicks.
- search (optional):
String
Search for a specific URL by its details. - status (optional):
String
Filter results by the status of the URL.
Request Body #
Description #
The API returns data for the specified date only. The date must be included in the request body.
{
"date": "2024-06-04"
}
Response Body #
Successful Response #
{
"message": "URL list fetched successfully",
"data": [
{
"_id": number,
"status": 1,
"is_deleted": false,
"expire_with_config": false,
"delete_with_config": false,
"is_rotator": false,
"is_multiple": false,
"deep_linking": false,
"tags": [],
"user_id": "string",
"note": "string",
"long_url": "string",
"domain_id": "string",
"short_code": "string",
"short_url": "string",
"metadata": {
"title": "string",
"description": "string",
"image": "string"
},
"password": "string",
"url_shortner_id": "string",
"rotating_urls": [],
"created_at": "string",
"space_id": "",
"utm": {
"utm_source": "string",
"utm_medium": "string",
"utm_campaign": "string"
},
"expiration_link": "string",
"totalClicks": number,
"todaysClick": number,
"domain": "string"
}
// Additional URL objects...
]
}
Each object in the data
array represents a URL with detailed information such as its ID, status, user details, and click statistics.