Links
GET https://om.om/api/links/
curl --request GET \
--url 'https://om.om/api/links/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://om.om/api/links/' \
--header 'Authorization: Bearer {api_key}' \
Parameters | Details | Description |
---|---|---|
page | Optional Integer | The page number that you want results from. Defaults to 1 . |
results_per_page | Optional Integer | How many results you want per page. Allowed values are: 10 , 25 , 50 , 100 , 250 , 500 , 1000 . Defaults to 25 . |
{
"data": [
{
"id": 1,
"project_id": null,
"domain_id": 0,
"type": "link",
"url": "example",
"location_url": "https://example.com/",
"settings": {
"password": null,
"sensitive_content": false
},
"clicks": 10,
"order": 0,
"start_date": null,
"end_date": null,
"date": "2020-11-15 12:00:00"
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://om.om/api/links?&page=1",
"last": "https://om.om/api/links?&page=1",
"next": null,
"prev": null,
"self": "https://om.om/api/links?&page=1"
}
}
GET https://om.om/api/links/{link_id}
curl --request GET \
--url 'https://om.om/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://om.om/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
{
"data": {
"id": 1,
"project_id": null,
"domain_id": 0,
"type": "link",
"url": "example",
"location_url": "https://example.com/",
"settings": {
"password": null,
"sensitive_content": false
},
"clicks": 10,
"order": 0,
"start_date": null,
"end_date": null,
"date": "2020-11-15 12:00:00"
}
}
POST https://om.om/api/links
Parameters | Details | Description |
---|---|---|
type | Optional String | link |
location_url | Required String | The URL of the destination. |
url | Optional String | The URL alias of the generated link. Leave empty for a randomly generated one. |
domain_id | Optional Integer | - |
project_id | Optional Integer | - |
pixels_ids | Optional Array Integer | - |
schedule | Optional Boolean | - |
start_date | Optional String | Available when: schedule = true |
end_date | Optional String | Available when: schedule = true |
clicks_limit | Optional Integer | - |
expiration_url | Optional String | - |
sensitive_content | Optional Boolean | - |
http_status_code | Optional Integer | Allowed values: 301 , 302 , 307 , 308 |
app_linking_is_enabled | Optional Boolean | - |
cloaking_is_enabled | Optional Boolean | - |
cloaking_title | Optional String | - |
cloaking_favicon | Optional File | - |
password | Optional String | - |
forward_query_parameters_is_enabled | Optional Boolean | - |
utm_source | Optional missing_translation: api_documentation.strings | - |
utm_medium | Optional missing_translation: api_documentation.strings | - |
utm_campaign | Optional missing_translation: api_documentation.strings | - |
targeting_type | Optional String | country_code , device_type , browser_language , rotation , os_name |
targeting_country_code_key[index] | Optional String | (targeting_type=country_code) |
targeting_country_code_value[index] | Optional String | (targeting_type=country_code) |
targeting_device_type_key[index] | Optional String | (targeting_type=device_type) |
targeting_device_type_value[index] | Optional String | (targeting_type=device_type) |
targeting_browser_language_key[index] | Optional String | (targeting_type=browser_language) |
targeting_browser_language_value[index] | Optional String | (targeting_type=browser_language) |
targeting_rotation_key[index] | Optional String | (targeting_type=rotation) |
targeting_rotation_value[index] | Optional String | (targeting_type=rotation) |
targeting_os_name_key[index] | Optional String | (targeting_type=os_name) |
targeting_os_name_value[index] | Optional String | (targeting_type=os_name) |
curl --request POST \
--url 'https://om.om/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://om.om/' \
--url 'https://om.om/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://om.om/' \
{
"data": {
"id": 1
}
}
POST https://om.om/api/links/{link_id}
Parameters | Details | Description |
---|---|---|
location_url | Optional String | The URL of the destination. |
url | Optional String | The URL alias of the generated link. Leave empty for a randomly generated one. |
domain_id | Optional Integer | - |
project_id | Optional Integer | - |
pixels_ids | Optional Array Integer | - |
schedule | Optional Boolean | - |
start_date | Optional String | Available when: schedule = true |
end_date | Optional String | Available when: schedule = true |
clicks_limit | Optional Integer | - |
expiration_url | Optional String | - |
sensitive_content | Optional Boolean | - |
http_status_code | Optional Integer | Allowed values: 301 , 302 , 307 , 308 |
app_linking_is_enabled | Optional Boolean | - |
cloaking_is_enabled | Optional Boolean | - |
cloaking_title | Optional String | - |
cloaking_favicon | Optional File | - |
password | Optional String | - |
forward_query_parameters_is_enabled | Optional Boolean | - |
utm_source | Optional missing_translation: api_documentation.strings | - |
utm_medium | Optional missing_translation: api_documentation.strings | - |
utm_campaign | Optional missing_translation: api_documentation.strings | - |
targeting_type | Optional String | country_code , device_type , browser_language , rotation , os_name |
targeting_country_code_key[index] | Optional String | (targeting_type=country_code) |
targeting_country_code_value[index] | Optional String | (targeting_type=country_code) |
targeting_device_type_key[index] | Optional String | (targeting_type=device_type) |
targeting_device_type_value[index] | Optional String | (targeting_type=device_type) |
targeting_browser_language_key[index] | Optional String | (targeting_type=browser_language) |
targeting_browser_language_value[index] | Optional String | (targeting_type=browser_language) |
targeting_rotation_key[index] | Optional String | (targeting_type=rotation) |
targeting_rotation_value[index] | Optional String | (targeting_type=rotation) |
targeting_os_name_key[index] | Optional String | (targeting_type=os_name) |
targeting_os_name_value[index] | Optional String | (targeting_type=os_name) |
curl --request POST \
--url 'https://om.om/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
--url 'https://om.om/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
{
"data": {
"id": 1
}
}
DELETE https://om.om/api/links/{link_id}
curl --request DELETE \
--url 'https://om.om/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://om.om/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \