अभियान

सभी को पुनः प्राप्त करें

GET https://popupke.com/api/campaigns/
curl --request GET \
--url 'https://popupke.com/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
पैरामीटर विवरण विवरण
search वैकल्पिक डोरी खोज स्ट्रिंग.
search_by वैकल्पिक डोरी What field are you searching by. Allowed values are: name, domain.
is_enabled वैकल्पिक बूलियन
datetime_field वैकल्पिक डोरी Allowed values: datetime, last_datetime
datetime_start वैकल्पिक डोरी Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end वैकल्पिक डोरी Filter results up to this datetime. Y-m-d H:i:s format.
order_by वैकल्पिक डोरी What field to order the results by. Allowed values are: campaign_id, datetime, last_datetime, name, domain.
order_type वैकल्पिक डोरी The ordering of the results. Allowed values are: ASC for ascending ordering, and DESC for descending ordering.
page वैकल्पिक पूर्णांक The page number that you want results from. Defaults to 1.
results_per_page वैकल्पिक पूर्णांक How many results you want per page. Allowed values are: 10, 25, 50, 100, 250, 500, 1000. Defaults to 25. 
{
    "data": [
        {
            "id": 1,
            "pixel_key": "1234567890abcdef",
            "name": "Example",
            "domain": "example.com",
            "branding": {
                "name": "",
                "url": ""
            },
            "email_reports_is_enabled": true,
            "email_reports_last_datetime": "2019-05-22 23:40:17",
            "is_enabled": true,
            "last_datetime": null,
            "datetime": "2026-05-21 02:18:13",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://popupke.com/api/campaigns?page=1",
        "last": "https://popupke.com/api/campaigns?page=1",
        "next": null,
        "prev": null,
        "self": "https://popupke.com/api/campaigns?page=1"
    }
}

एक पुनः प्राप्त करें

GET https://popupke.com/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://popupke.com/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "pixel_key": "1234567890abcdef",
        "name": "Example",
        "domain": "example.com",
        "branding": {
            "name": "",
            "url": ""
        },
        "email_reports_is_enabled": true,
        "email_reports_last_datetime": "2019-05-22 23:40:17",
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-05-21 02:18:13",
    }
}

बनाएं

POST https://popupke.com/api/campaigns
पैरामीटर विवरण विवरण
domain_id वैकल्पिक पूर्णांक -
name आवश्यक डोरी -
domain आवश्यक डोरी -
branding_name वैकल्पिक डोरी -
branding_url वैकल्पिक डोरी -
email_reports वैकल्पिक सरणी Notification handler ids
is_enabled वैकल्पिक बूलियन -
curl --request POST \
--url 'https://popupke.com/api/campaigns' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'domain=example.com' \
{
    "data": {
        "id": 1
    }
}

अद्यतन

POST https://popupke.com/api/campaigns/{campaign_id}
पैरामीटर विवरण विवरण
domain_id वैकल्पिक पूर्णांक -
name वैकल्पिक डोरी -
domain वैकल्पिक डोरी -
branding_name वैकल्पिक डोरी -
branding_url वैकल्पिक डोरी -
email_reports वैकल्पिक सरणी Notification handler ids
is_enabled वैकल्पिक बूलियन -
curl --request POST \
--url 'https://popupke.com/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
{
    "data": {
        "id": 1
    }
}

मिटाना

DELETE https://popupke.com/api/campaigns/{campaign_id}
curl --request DELETE \
--url 'https://popupke.com/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \