Sites

Recuperar todos

Endpoint

GET https://analytics.ipcidr.com/api/websites/

Exemplo

curl --request GET \
--url 'https://analytics.ipcidr.com/api/websites/' \
--header 'Authorization: Bearer {api_key}' \

Parâmetros	Detalhes	Descrição
search	Opcional String	A string de pesquisa.
search_by	Opcional String	Por qual campo você está pesquisando. Valores permitidos são: `name`, `host`.
is_enabled	Opcional Inteiro
tracking_type	Opcional String	Valores permitidos: `normal`, `lightweight`
domain_id	Opcional Inteiro
datetime_field	Opcional String	Valores permitidos: `datetime`, `last_datetime`
datetime_start	Opcional String	Filtrar resultados a partir desta data/hora. Formato `Y-m-d H:i:s`.
datetime_end	Opcional String	Filtrar resultados até esta data/hora. Formato `Y-m-d H:i:s`.
order_by	Opcional String	Por qual campo ordenar os resultados. Valores permitidos são: `website_id`, `datetime`, `last_datetime`, `name`, `host`, `current_month_sessions_events`.
order_type	Opcional String	A ordenação dos resultados. Valores permitidos são: `ASC` para ordenação crescente e `DESC` para ordenação decrescente.
page	Opcional Inteiro	O número da página de onde você deseja resultados. O padrão é `1`.
results_per_page	Opcional Inteiro	Quantos resultados você deseja por página. Valores permitidos são: `10`, `25`, `50`, `100`, `250`, `500`, `1000`. O padrão é `25`.

Exemplo de resposta

{
    "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-06-04 02:05:16",
            "last_datetime": null
        },
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://analytics.ipcidr.com/api/websites?page=1",
        "last": "https://analytics.ipcidr.com/api/websites?page=1",
        "next": null,
        "prev": null,
        "self": "https://analytics.ipcidr.com/api/websites?page=1"
    }
}

Recuperar um

Endpoint

GET https://analytics.ipcidr.com/api/websites/{website_id}

Exemplo

curl --request GET \
--url 'https://analytics.ipcidr.com/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \

Exemplo de resposta

{
    "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-06-04 02:05:16",
        "last_datetime": null
    }
}

curl --request POST \
--url 'https://analytics.ipcidr.com/api/websites' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'host=website.com' \
--form 'name=Example' \

Exemplo de resposta

{
    "data": {
        "id": 1
    }
}

Atualizar

Endpoint

POST https://analytics.ipcidr.com/api/websites/{website_id}

Parâmetros	Detalhes	Descrição
domain_id	Opcional Inteiro	-
name	Opcional String	-
scheme	Opcional String	Valores permitidos: `http://`, `https://`
host	Opcional String	Exemplo: `example.com/path`.
excluded_ips	Opcional String	Excluir 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ários). Valores permitidos: `0` ou `1`. Disponível apenas para tipo de rastreamento `normal`.
sessions_replays_is_enabled	Opcional Booleano	Replays de sessão. Valores permitidos: `0` ou `1`. Disponível apenas para tipo de rastreamento `normal`.
sessions_replays_hide_text_selector	Opcional String
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 String	-
is_enabled	Opcional Booleano	-

Exemplo

curl --request POST \
--url 'https://analytics.ipcidr.com/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'is_enabled=0' \

Exemplo de resposta

{
    "data": {
        "id": 1
    }
}

Excluir

Endpoint

DELETE https://analytics.ipcidr.com/api/websites/{website_id}

Exemplo

curl --request DELETE \
--url 'https://analytics.ipcidr.com/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \

Recuperar todos

Recuperar um

Criar

Atualizar

Excluir