Sites

Recuperar todos

GET https://vi.app.br/api/websites/
curl --request GET \
--url 'https://vi.app.br/api/websites/' \
--header 'Authorization: Bearer {api_key}' \
Parâmetros Detalhes Descrição
page Opcional Inteiro O número da página da qual você quer resultados. Padrão é 1.
results_per_page Opcional Inteiro Quantos resultados por página. Valores permitidos: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Padrão: 25. 
{
    "data": [
        {
            "id": 1,
            "pixel_key": "1234567890123456",
            "name": "Localhost",
            "scheme": "https://",
            "host": "example.com",
            "path": "/",
            "tracking_type": "normal",
            "excluded_ips": "",
            "outbound_clicks_is_enabled": false,
            "events_children_is_enabled": false,
            "sessions_replays_is_enabled": false,
            "email_reports_is_enabled": false,
            "email_reports_last_date": "2020-06-23 19:01:22",
            "bot_exclusion_is_enabled": true,
            "query_parameters_tracking_is_enabled": true,
            "ip_storage_is_enabled": false,
            "public_statistics_is_enabled": false,
            "public_statistics_password": false,
            "is_enabled": true,
            "datetime": "2026-03-06 00:42:03",
            "last_datetime": null
        },
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://vi.app.br/api/websites?page=1",
        "last": "https://vi.app.br/api/websites?page=1",
        "next": null,
        "prev": null,
        "self": "https://vi.app.br/api/websites?page=1"
    }
}

Recuperar um

GET https://vi.app.br/api/websites/{website_id}
curl --request GET \
--url 'https://vi.app.br/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "pixel_key": "1234567890123456",
        "name": "Localhost",
        "scheme": "https://",
        "host": "example.com",
        "path": "/",
        "tracking_type": "normal",
        "excluded_ips": "",
        "outbound_clicks_is_enabled": false,
        "events_children_is_enabled": false,
        "sessions_replays_is_enabled": false,
        "email_reports_is_enabled": false,
        "email_reports_last_date": "2020-06-23 19:01:22",
        "bot_exclusion_is_enabled": true,
        "query_parameters_tracking_is_enabled": true,
        "ip_storage_is_enabled": false,
        "public_statistics_is_enabled": false,
        "public_statistics_password": false,
        "is_enabled": true,
        "datetime": "2026-03-06 00:42:03",
        "last_datetime": null
    }
}

Criar

POST https://vi.app.br/api/websites
Parâmetros Detalhes Descrição
domain_id Opcional Inteiro -
name Obrigatório Texto -
scheme Opcional Texto Valores permitidos: http://, https://
host Obrigatório Texto Exemplo: exemplo.com/caminho.
tracking_type Opcional Texto Valores permitidos: lightweight, normal
excluded_ips Opcional Texto Exclua IPs do rastreamento. Insira valores separados por vírgula.
outbound_clicks_is_enabled Opcional Booleano
events_children_is_enabled Opcional Booleano Rastrear eventos de visitantes (cliques do mouse, redimensionamentos, rolagens, envios de formulário). Valores permitidos: 0 ou 1. Disponível apenas para o tipo de rastreamento normal.
sessions_replays_is_enabled Opcional Booleano Reproduções de sessão. Valores permitidos: 0 ou 1. Disponível apenas para o tipo de rastreamento normal.
sessions_replays_hide_text_selector Opcional Texto
email_reports_is_enabled Opcional Booleano Relatórios por e-mail. Valores permitidos: 0 ou 1.
ip_storage_is_enabled Opcional Booleano Disponível quando: tracking_type = normal
query_parameters_tracking_is_enabled Opcional Booleano -
bot_exclusion_is_enabled Opcional Booleano -
public_statistics_is_enabled Opcional Booleano -
public_statistics_password Opcional Texto -
is_enabled Opcional Booleano -
curl --request POST \
--url 'https://vi.app.br/api/websites' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'host=website.com' \
--form 'name=Example' \
{
    "data": {
        "id": 1
    }
}

Atualizar

POST https://vi.app.br/api/websites/{website_id}
Parâmetros Detalhes Descrição
domain_id Opcional Inteiro -
name Opcional Texto -
scheme Opcional Texto Valores permitidos: http://, https://
host Opcional Texto Exemplo: exemplo.com/caminho.
excluded_ips Opcional Texto Exclua IPs do rastreamento. Insira valores separados por vírgula.
outbound_clicks_is_enabled Opcional Booleano
events_children_is_enabled Opcional Booleano Rastrear eventos de visitantes (cliques do mouse, redimensionamentos, rolagens, envios de formulário). Valores permitidos: 0 ou 1. Disponível apenas para o tipo de rastreamento normal.
sessions_replays_is_enabled Opcional Booleano Reproduções de sessão. Valores permitidos: 0 ou 1. Disponível apenas para o tipo de rastreamento normal.
sessions_replays_hide_text_selector Opcional Texto
email_reports_is_enabled Opcional Booleano Relatórios por e-mail. Valores permitidos: 0 ou 1.
ip_storage_is_enabled Opcional Booleano Disponível quando: tracking_type = normal
query_parameters_tracking_is_enabled Opcional Booleano -
bot_exclusion_is_enabled Opcional Booleano -
public_statistics_is_enabled Opcional Booleano -
public_statistics_password Opcional Texto -
is_enabled Opcional Booleano -
curl --request POST \
--url 'https://vi.app.br/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'is_enabled=0' \
{
    "data": {
        "id": 1
    }
}

Excluir

DELETE https://vi.app.br/api/websites/{website_id}
curl --request DELETE \
--url 'https://vi.app.br/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \