Kampanijos

Atkurti viską

GET https://socialproof.store/api/campaigns/
curl --request GET \
--url 'https://socialproof.store/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
Parametrai Detalės Aprašymas
search Pasirinktinis Eilutė Paieškos eilutė.
search_by Pasirinktinis Eilutė Kokio lauko ieškote. Leidžiamos reikšmės yra: name, domain.
is_enabled Pasirinktinis Bulio tipas
datetime_field Pasirinktinis Eilutė Leidžiamos reikšmės: datetime, last_datetime
datetime_start Pasirinktinis Eilutė Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end Pasirinktinis Eilutė Filter results up to this datetime. Y-m-d H:i:s format.
order_by Pasirinktinis Eilutė Kokiu lauku rūšiuoti rezultatus. Leidžiamos reikšmės yra: campaign_id, datetime, last_datetime, name, domain.
order_type Pasirinktinis Eilutė Rezultatų rikiavimas. Leidžiamos reikšmės yra: ASC rikiavimui didėjimo tvarka ir DESC rikiavimui mažėjimo tvarka.
page Pasirinktinis Sveikasis skaičius Puslapio numeris, iš kurio norite gauti rezultatus. Pagal nutylėjimą yra 1.
results_per_page Pasirinktinis Sveikasis skaičius Kiek rezultatų norite matyti puslapyje. Leidžiamos reikšmės yra: 10, 25, 50, 100, 250, 500, 1000. Numatytoji reikšmė yra 25. 
{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "pixel_key": "Example",
            "name": "Example",
            "domain": "Example",
            "branding": {},
            "email_reports_is_enabled": true,
            "email_reports_last_datetime": "2026-10-11 23:05:49",
            "is_enabled": true,
            "last_datetime": null,
            "datetime": "2026-10-11 23:05:49"
        }
    ],
    "meta": {
        "page": 1,
        "total_pages": 1,
        "results_per_page": 25,
        "total_results": 1
    },
    "links": {
        "first": "https://socialproof.store/api/campaigns?page=1",
        "last": "https://socialproof.store/api/campaigns?page=1",
        "next": null,
        "prev": null,
        "self": "https://socialproof.store/api/campaigns?page=1"
    }
}

Atsiimkite vieną

GET https://socialproof.store/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://socialproof.store/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "pixel_key": "Example",
        "name": "Example",
        "domain": "Example",
        "branding": {},
        "email_reports_is_enabled": true,
        "email_reports_last_datetime": "2026-10-11 23:05:49",
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-10-11 23:05:49"
    }
}

Sukurti

POST https://socialproof.store/api/campaigns
Parametrai Detalės Aprašymas
domain_id Pasirinktinis Sveikasis skaičius -
name Reikalingas Eilutė -
domain Reikalingas Eilutė -
branding_name Pasirinktinis Eilutė -
branding_url Pasirinktinis Eilutė -
email_reports Pasirinktinis Masyvas Pranešimų apdorojimo identifikatoriai
is_enabled Pasirinktinis Bulio tipas -
curl --request POST \
--url 'https://socialproof.store/api/campaigns' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'domain=example.com' \
{
    "data": {
        "id": 1,
        "user_id": 1,
        "pixel_key": "Example",
        "name": "Example",
        "domain": "Example",
        "branding": {},
        "email_reports_is_enabled": "Example",
        "email_reports_last_datetime": null,
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-10-11 23:05:49"
    }
}

Atnaujinti

POST https://socialproof.store/api/campaigns/{campaign_id}
Parametrai Detalės Aprašymas
domain_id Pasirinktinis Sveikasis skaičius -
name Pasirinktinis Eilutė -
domain Pasirinktinis Eilutė -
branding_name Pasirinktinis Eilutė -
branding_url Pasirinktinis Eilutė -
email_reports Pasirinktinis Masyvas Pranešimų apdorojimo identifikatoriai
is_enabled Pasirinktinis Bulio tipas -
curl --request POST \
--url 'https://socialproof.store/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
{
    "data": {
        "id": 1,
        "user_id": 1,
        "pixel_key": "Example",
        "name": "Example",
        "domain": "Example",
        "branding": {},
        "email_reports_is_enabled": true,
        "email_reports_last_datetime": "2026-10-11 23:05:49",
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-10-11 23:05:49"
    }
}

Ištrinti

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