Websites
GET https://freepush.cc/api/websites/
curl --request GET \
--url 'https://freepush.cc/api/websites/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://freepush.cc/api/websites/' \
--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,
"user_id": 1,
"website_id": 1,
"domain_id": 0,
"pixel_key": "abc123abc123",
"name": "Example",
"scheme": "https://",
"host": "example.com",
"path": "/path",
"settings": {
"icon": null,
"ip_storage_is_enabled": 1,
"branding_name": "",
"branding_url": ""
},
"widget": {
"is_enabled": true,
"title": "Get notified on discount campaigns 🔥",
"description": "Once a month, no spam, unsubscribe at any time.",
"subscribe_button": "Subscribe",
"close_button": "Not now",
"image_url": "https://example.com/pixel/bell.svg",
"image_alt": "",
"subscribed_title": "Welcome ✨",
"subscribed_description": "Thank you for subscribing!",
"subscribed_image_url": "https://example.com/check-circle.svg",
"subscribed_image_alt": "",
"subscribed_success_url": "",
"permission_denied_title": "Push notifications denied permission",
"permission_denied_description": "If you wish to subscribe - please reset your browser's notification permissions.",
"permission_denied_refresh_button": "Refresh page",
"permission_denied_close_button": "Close",
"permission_denied_image_url": "https://example.com/pixel/sad.svg",
"permission_denied_image_alt": "",
"display_continents": [],
"display_countries": [],
"display_languages": [],
"display_operating_systems": [],
"display_browsers": [],
"display_mobile": true,
"display_desktop": true,
"trigger_all_pages": true,
"triggers": [],
"display_trigger": "delay",
"display_trigger_value": 5,
"display_frequency": "all_time",
"display_delay_type_after_close": "time_on_site",
"display_delay_value_after_close": 3600,
"direction": "ltr",
"display_duration": -1,
"display_position": "top_center",
"display_branding": true,
"font": "inherit",
"title_color": "#000000",
"description_color": "#000000",
"background_color": "#ffffff",
"subscribe_button_text_color": "#ffffff",
"subscribe_button_background_color": "#000000",
"close_button_text_color": "#4c5461",
"close_button_background_color": "#f1f2f4",
"border_color": "#000000",
"internal_padding": 12,
"display_shadow": false,
"border_radius": "rounded",
"border_width": 0,
"hover_animation": "",
"on_animation": "",
"off_animation": "",
"animation": "",
"animation_interval": 5
},
"button": {
"is_enabled": false,
"title": "Subscribe for discounts 🔥",
"description": "Unsubscribe at any time, no spam.",
"image_url": "https://example.com/pixel/bell.svg",
"image_alt": "",
"subscribed_title": "Welcome ✨",
"subscribed_description": "Thank you for subscribing!",
"subscribed_image_url": "https://example.com/check-circle.svg",
"subscribed_image_alt": "",
"subscribed_success_url": "",
"unsubscribe_title": "Unsubscribe",
"unsubscribe_description": "Click to unsubscribe.",
"unsubscribe_image_url": "https://example.com/minus-circle.svg",
"unsubscribe_image_alt": "",
"unsubscribe_success_url": "",
"unsubscribed_title": "Bye bye 👋",
"unsubscribed_description": "You can subscribe back at any time!",
"unsubscribed_image_url": "https://example.com/minus-circle.svg",
"unsubscribed_image_alt": "",
"unsubscribed_success_url": "",
"permission_denied_title": "Browser denied permission",
"permission_denied_description": "Reset your browser's notification permissions to subscribe.",
"permission_denied_image_url": "https://example.com/pixel/sad.svg",
"permission_denied_image_alt": "",
"display_continents": [],
"display_countries": [],
"display_languages": [],
"display_operating_systems": [],
"display_browsers": [],
"display_mobile": true,
"display_desktop": true,
"trigger_all_pages": true,
"triggers": [],
"direction": "ltr",
"display_branding": true,
"font": "inherit",
"title_color": "#000000",
"description_color": "#000000",
"background_color": "#f5f6f7",
"border_color": "#000000",
"internal_padding": 12,
"display_shadow": false,
"border_radius": "rounded",
"border_width": 0,
"hover_animation": ""
},
"notifications": [],
"keys": {
"public_key": "123",
"private_key": "123"
},
"total_sent_campaigns": 1,
"total_subscribers": 1,
"total_sent_push_notifications": 1,
"total_displayed_push_notifications": 1,
"total_clicked_push_notifications": 0,
"total_closed_push_notifications": 1,
"is_enabled": true,
"last_datetime": null,
"datetime": "2024-08-01 01:55:41"
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://freepush.cc/api/websites?&page=1",
"last": "https://freepush.cc/api/websites?&page=1",
"next": null,
"prev": null,
"self": "https://freepush.cc/api/websites?&page=1"
}
}
GET https://freepush.cc/api/websites/{website_id}
curl --request GET \
--url 'https://freepush.cc/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://freepush.cc/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \
{
"data": {
"id": 1,
"user_id": 1,
"website_id": 1,
"domain_id": 0,
"pixel_key": "abc123abc123",
"name": "Example",
"scheme": "https://",
"host": "example.com",
"path": "/path",
"settings": {
"icon": null,
"ip_storage_is_enabled": 1,
"branding_name": "",
"branding_url": ""
},
"widget": {
"is_enabled": true,
"title": "Get notified on discount campaigns 🔥",
"description": "Once a month, no spam, unsubscribe at any time.",
"subscribe_button": "Subscribe",
"close_button": "Not now",
"image_url": "https://example.com/pixel/bell.svg",
"image_alt": "",
"subscribed_title": "Welcome ✨",
"subscribed_description": "Thank you for subscribing!",
"subscribed_image_url": "https://example.com/check-circle.svg",
"subscribed_image_alt": "",
"subscribed_success_url": "",
"permission_denied_title": "Push notifications denied permission",
"permission_denied_description": "If you wish to subscribe - please reset your browser's notification permissions.",
"permission_denied_refresh_button": "Refresh page",
"permission_denied_close_button": "Close",
"permission_denied_image_url": "https://example.com/pixel/sad.svg",
"permission_denied_image_alt": "",
"display_continents": [],
"display_countries": [],
"display_languages": [],
"display_operating_systems": [],
"display_browsers": [],
"display_mobile": true,
"display_desktop": true,
"trigger_all_pages": true,
"triggers": [],
"display_trigger": "delay",
"display_trigger_value": 5,
"display_frequency": "all_time",
"display_delay_type_after_close": "time_on_site",
"display_delay_value_after_close": 3600,
"direction": "ltr",
"display_duration": -1,
"display_position": "top_center",
"display_branding": true,
"font": "inherit",
"title_color": "#000000",
"description_color": "#000000",
"background_color": "#ffffff",
"subscribe_button_text_color": "#ffffff",
"subscribe_button_background_color": "#000000",
"close_button_text_color": "#4c5461",
"close_button_background_color": "#f1f2f4",
"border_color": "#000000",
"internal_padding": 12,
"display_shadow": false,
"border_radius": "rounded",
"border_width": 0,
"hover_animation": "",
"on_animation": "",
"off_animation": "",
"animation": "",
"animation_interval": 5
},
"button": {
"is_enabled": false,
"title": "Subscribe for discounts 🔥",
"description": "Unsubscribe at any time, no spam.",
"image_url": "https://example.com/pixel/bell.svg",
"image_alt": "",
"subscribed_title": "Welcome ✨",
"subscribed_description": "Thank you for subscribing!",
"subscribed_image_url": "https://example.com/check-circle.svg",
"subscribed_image_alt": "",
"subscribed_success_url": "",
"unsubscribe_title": "Unsubscribe",
"unsubscribe_description": "Click to unsubscribe.",
"unsubscribe_image_url": "https://example.com/minus-circle.svg",
"unsubscribe_image_alt": "",
"unsubscribe_success_url": "",
"unsubscribed_title": "Bye bye 👋",
"unsubscribed_description": "You can subscribe back at any time!",
"unsubscribed_image_url": "https://example.com/minus-circle.svg",
"unsubscribed_image_alt": "",
"unsubscribed_success_url": "",
"permission_denied_title": "Browser denied permission",
"permission_denied_description": "Reset your browser's notification permissions to subscribe.",
"permission_denied_image_url": "https://example.com/pixel/sad.svg",
"permission_denied_image_alt": "",
"display_continents": [],
"display_countries": [],
"display_languages": [],
"display_operating_systems": [],
"display_browsers": [],
"display_mobile": true,
"display_desktop": true,
"trigger_all_pages": true,
"triggers": [],
"direction": "ltr",
"display_branding": true,
"font": "inherit",
"title_color": "#000000",
"description_color": "#000000",
"background_color": "#f5f6f7",
"border_color": "#000000",
"internal_padding": 12,
"display_shadow": false,
"border_radius": "rounded",
"border_width": 0,
"hover_animation": ""
},
"notifications": [],
"keys": {
"public_key": "123",
"private_key": "123"
},
"total_sent_campaigns": 1,
"total_subscribers": 1,
"total_sent_push_notifications": 1,
"total_displayed_push_notifications": 1,
"total_clicked_push_notifications": 0,
"total_closed_push_notifications": 1,
"is_enabled": true,
"last_datetime": null,
"datetime": "2024-08-01 01:55:41"
}
}
DELETE https://freepush.cc/api/websites/{website_id}
curl --request DELETE \
--url 'https://freepush.cc/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://freepush.cc/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \