Instale o nosso app 🪄 clique no ícone no canto superior direito da barra de endereços.

Campanhas

Recuperar tudo

GET https://maiscliques.com.br/api/campaigns/
curl --request GET \
--url 'https://maiscliques.com.br/api/campaigns/' \
--header 'Authorization: Bearer {api_key}' \
Parâmetros Detalhes Descrição
search Opcional String A cadeia de pesquisa.
search_by Opcional String Por qual campo você está pesquisando. Os valores permitidos são: name , domain.
is_enabled Opcional Booleano
order_by Opcional String Por qual campo ordenar os resultados. Os valores permitidos são: campaign_id , datetime , last_datetime , name , domain.
order_type Opcional String A ordenação dos resultados. Os valores permitidos são: ASC para ordenação ascendente, e DESC para ordenação descendente.
page Opcional Inteiro O número da página da qual você quer resultados. O padrão é 1.
results_per_page Opcional Inteiro Quantos resultados pretende por página. Os valores permitidos são: 10 , 25 , 50 , 100 , 250 , 500 , 1000. O padrão é 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-03-13 21:34:57",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://maiscliques.com.br/api/campaigns?page=1",
        "last": "https://maiscliques.com.br/api/campaigns?page=1",
        "next": null,
        "prev": null,
        "self": "https://maiscliques.com.br/api/campaigns?page=1"
    }
}

Recuperar um

GET https://maiscliques.com.br/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://maiscliques.com.br/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-03-13 21:34:57",
    }
}

Criar

POST https://maiscliques.com.br/api/campaigns
Parâmetros Detalhes Descrição
domain_id Opcional Inteiro -
name Obrigatório String -
domain Obrigatório String -
branding_name Opcional String -
branding_url Opcional String -
email_reports Opcional Array IDs do manipulador de notificações
is_enabled Opcional Booleano -
curl --request POST \
--url 'https://maiscliques.com.br/api/campaigns' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'domain=example.com' \
{
    "data": {
        "id": 1
    }
}

Atualizar

POST https://maiscliques.com.br/api/campaigns/{campaign_id}
Parâmetros Detalhes Descrição
domain_id Opcional Inteiro -
name Opcional String -
domain Opcional String -
branding_name Opcional String -
branding_url Opcional String -
email_reports Opcional Array IDs do manipulador de notificações
is_enabled Opcional Booleano -
curl --request POST \
--url 'https://maiscliques.com.br/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
{
    "data": {
        "id": 1
    }
}

Eliminar

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