Get All Applications for Deep Link #
To create a single deep link, retrieve your application’s “deep_link_app_id" using this API.
API Endpoint #
GET /api/user/v1/deeplinkapps
Query Parameters #
app_type (integer): Specify the type of application to retrieve.
0: Social apps1: Shopping apps2: Music apps3: Entertainment apps4: Business apps5: Drinks & Food apps6: Travel apps7: Utility apps8: News apps9: Finance apps
Request Example #
curl --location --request GET 'https://apiv2.foxlyme.com/api/user/v1/deeplinkapps?
app_type=number' \
--header 'api-key: API_KEY' \
--data-raw ''
Response Body #
json
{
"error": false,
"message": "all application fetch successfully",
"data": [
{
"_id": number,
"android_first_url": "string",
"app_type": number,
"android_last_url": "",
"ios_url": "amexapp:",
"app_name": "string",
"app_key": "string",
"app_icon": "url",
"deep_link_app_id": "String",
"created_at": "String",
"updated_at": "String",
"__v": number
},
...
]
}
Create a Single Deep Link #
API Endpoint #
POST /api/user/v1/deeplink
Query Parameters #
- domain (string): The domain to use for the deep link.
- deep_link_app_id (string): The ID of the application for which the deep link is being created.
- domain_id=string
Request Example #
curl --location --request POST 'https://apiv2.foxlyme.com/api/user/v1/deeplink?
domain=string&deep_link_app_id=string&domain_id=string' \
--header 'api-key: API_KEY' \
--data-raw '{
"long_url": "string",
"custom_code": "String",
"description": "String",
"title": "String"
}'
Request Body #
- long_url (string): The original URL to be shortened.
- custom_code (string): A custom code for the deep link (optional).
- description (string): A description of the deep link (optional).
- title (string): The title of the deep link (optional).
Response Body #
json
{
"error": false,
"message": "url short successfully"
}
Update a Single Deep Link #
API Endpoint #
PUT /api/user/v1/editdeeplink
Query Parameters #
- deep_link_id (string): The ID of the deep link to update.
- deep_link_app_id (string): The ID of the application associated with the deep link.
Request Example #
curl --location --request PUT 'https://apiv2.foxlyme.com/api/user/v1/editdeeplink?
deep_link_id=string&deep_link_app_id=string' \
--header 'api-key: API_KEY' \
--data-raw '{
"long_url": "string",
"custom_code": "String",
"description": "String",
"title": "String"
}'
Request Body #
- long_url (string): The original URL to be updated.
- custom_code (string): A custom code for the deep link (optional).
- description (string): A description of the deep link (optional).
- title (string): The title of the deep link (optional).
Response Body #
json
{
"error": false,
"message": "Url Updated successfully",
"data": {
"metadata": {
"image": "String",
"title": "String",
"description": "String"
},
"status": 1,
"is_deleted": false,
"_id": number,
"user_id": "String",
"long_url": "String",
"domain_id": "String",
"short_code": "String",
"deep_link_app_id": "String",
"short_url": "String",
"ios_url": "String",
"app_name": "String",
"android_url": "String",
"app_key": "String",
"deep_link_id": "String",
"created_at": "String",
"updated_at": "String",
"__v": number
}
}
Get All Your Deep Links #
API Endpoint #
GET /api/user/v1/deeplink/all
Request Example #
curl --location --request GET 'https://apiv2.foxlyme.com/api/user/v1/deeplink/all' \
--header 'api-key: API_KEY'
Response Body #
json
{
"message": "URL list fetched successfully",
"data": [
{
"_id": number,
"status": 1,
"is_deleted": false,
"user_id": "String",
"long_url": "String",
"domain_id": "String",
"short_code": "String",
"deep_link_app_id": "String",
"short_url": "String",
"deep_link_id": "String",
"created_at": "String",
"totalClicks": number,
"app_name": "String",
"app_key": "String",
"domain": "String"
}
// Additional deep links...
]
}Get Your Single Deep Link #
API Endpoint #
GET /api/user/v1/singledeeplink
Query Parameters #
- deep_link_id (string): The ID of the deep link to retrieve.
Request Example #
curl --location --request GET 'https://apiv2.foxlyme.com/api/user/v1/singledeeplink?
deep_link_id=string' \
--header 'api-key: API_KEY'
Response Body #
json
{
"data": {
"error": false,
"message": "strings",
"todayClicks": number,
"totalClick": number,
"data": [
{
"metadata": {
"image": "",
"title": "Strings",
"description": "Strings"
},
"status": 1,
"is_deleted": false,
"_id": number,
"user_id": "strings",
"long_url": "strings",
"domain_id": "strings",
"short_code": "strings",
"deep_link_app_id": "strings",
"short_url": "strings",
"ios_url": "strings",
"app_name": "strings",
"android_url": "string",
"app_key": "string",
"deep_link_id": "string",
"created_at": "string",
"updated_at": "string",
"__v": number
}
]
}
}Delete Your Deep Link #
API Endpoint #
DELETE /api/user/v1/deletedeeplink
Query Parameters #
- deep_link_id (string): The ID of the deep link to delete.
Request Example #
curl --location --request DELETE 'https://apiv2.foxlyme.com/api/user/v1/deletedeeplink?
deep_link_id=string' \
--header 'api-key: API_KEY'
Response Body #
json
{
"error": false,
"message": "Url deleted successfully"
}
