Get All URL List API Documentation

API Endpoint #

Get All URL List #

Endpoint: GET /api/user/v1/url_list
cURL Command:

curl --location --request GET 'https://apiv2.foxlyme.com/api/user/
v1/url_list' --header 'api-key: API_KEY'

Query Parameters #

• page (optional): Number
  Specifies the page number for pagination.
• limit (optional): Number
  Specifies the number of results per page.
• sortBy (optional): String
  Sorts the results based on the 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
  Searches for a specific URL based on the provided information.
• status (optional): String
  Filters the results based on the status of the URL.

Response Body #

Successful Response #

{
  "message": "URL list fetched successfully",
  "count": 6,
  "data": [
    {
      "status": 1,
      "tags": [],
      "user_id": "string",
      "long_url": "string",
      "google_analytics_id": "",
      "pixel_id": "",
      "domain_id": "string",
      "short_code": "string",
      "short_url": "string",
      "url_shortner_id": "string",
      "rotating_urls": [],
      "created_at": "string",
      "totalClicks": number,
      "domain": "string"
    }
    // Additional URL objects...
  ]
}

Each object in the data array represents a URL with detailed information such as its status, user details, and click statistics.