Mappe di calore

Recupera tutti

GET https://hootmaps.com/api/heatmaps/
curl --request GET \
--url 'https://hootmaps.com/api/heatmaps/' \
--header 'Authorization: Bearer {api_key}' \
Parametri Dettagli Descrizione
website_id Facoltativo Intero
user_id Facoltativo Intero
is_enabled Facoltativo Intero Valori consentiti: 0, 1
search Facoltativo Traduci, ma evita di restituire punti finali: Stringa La stringa di ricerca
search_by Facoltativo Traduci, ma evita di restituire punti finali: Stringa In quale campo stai cercando. I valori ammessi sono: name, path
datetime_field Facoltativo Traduci, ma evita di restituire punti finali: Stringa Valori consentiti: datetime, last_datetime
datetime_start Facoltativo Traduci, ma evita di restituire punti finali: Stringa Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end Facoltativo Traduci, ma evita di restituire punti finali: Stringa Filter results up to this datetime. Y-m-d H:i:s format.
order_by Facoltativo Traduci, ma evita di restituire punti finali: Stringa Campo per ordinare i risultati. I valori ammessi sono: heatmap_id, website_id, name, path, is_enabled, desktop_size, tablet_size, mobile_size, datetime, last_datetime
order_type Facoltativo Traduci, ma evita di restituire punti finali: Stringa L'ordinamento dei risultati. I valori ammessi sono: ASC per un ordinamento ascendente e DESC per un ordinamento discendente
page Facoltativo Intero Il numero di pagina da cui desideri ottenere i risultati. Il valore predefinito è 1
results_per_page Facoltativo Intero Quanti risultati desideri per pagina. I valori consentiti sono: 10, 25, 50, 100, 250, 500, 1000. Il valore predefinito è 25 
{
    "data": [
        {
            "id": 1,
            "website_id": 1,
            "user_id": 1,
            "snapshot_id_desktop": 1,
            "desktop_size": 123456,
            "snapshot_id_tablet": null,
            "tablet_size": 0,
            "snapshot_id_mobile": null,
            "mobile_size": 0,
            "name": "Example",
            "path": "/",
            "is_enabled": true,
            "datetime": "2026-09-13 06:04:06",
            "last_datetime": null
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total_results": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://hootmaps.com/api/heatmaps?page=1",
        "last": "https://hootmaps.com/api/heatmaps?page=1",
        "next": null,
        "prev": null,
        "self": "https://hootmaps.com/api/heatmaps?page=1"
    }
}

Recupera uno

GET https://hootmaps.com/api/heatmaps/{heatmap_id}
curl --request GET \
--url 'https://hootmaps.com/api/heatmaps/{heatmap_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "website_id": 1,
        "user_id": 1,
        "snapshot_id_desktop": 1,
        "desktop_size": 123456,
        "snapshot_id_tablet": null,
        "tablet_size": 0,
        "snapshot_id_mobile": null,
        "mobile_size": 0,
        "name": "Example",
        "path": "/",
        "is_enabled": true,
        "datetime": "2026-09-13 06:04:06",
        "last_datetime": null
    }
}

Retrieve data

GET https://hootmaps.com/api/heatmaps/{heatmap_id}/data
curl --request GET \
--url 'https://hootmaps.com/api/heatmaps/{heatmap_id}/data?snapshot_type=desktop&type=clicks&start_date=2026-01-01&end_date=2026-01-31' \
--header 'Authorization: Bearer {api_key}' \
Parametri Dettagli Descrizione
snapshot_type Facoltativo Traduci, ma evita di restituire punti finali: Stringa Valori consentiti: desktop, tablet, mobile
type Facoltativo Traduci, ma evita di restituire punti finali: Stringa Valori consentiti: clicks, scrolls
start_date Facoltativo Traduci, ma evita di restituire punti finali: Stringa Data di inizio nel formato Y-m-d
end_date Facoltativo Traduci, ma evita di restituire punti finali: Stringa Data di fine nel formato Y-m-d 
{
    "data": {
        "id": 1,
        "website_id": 1,
        "snapshot_id": 1,
        "snapshot_type": "desktop",
        "type": "clicks",
        "start_date": "2026-01-01",
        "end_date": "2026-01-31",
        "heatmap_data": [
            [25.25, 60.5, 1]
        ],
        "heatmap_data_count": 1
    }
}

Crea

POST https://hootmaps.com/api/heatmaps
Parametri Dettagli Descrizione
website_id Necessario Intero
name Necessario Traduci, ma evita di restituire punti finali: Stringa
path Facoltativo Traduci, ma evita di restituire punti finali: Stringa
is_enabled Facoltativo Intero Valori consentiti: 0, 1
curl --request POST \
--url 'https://hootmaps.com/api/heatmaps' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'website_id=1' \
--form 'name=Example' \
--form 'path=/' \
--form 'is_enabled=1' \ 
{
    "data": {
        "id": 1,
        "website_id": 1,
        "user_id": 1,
        "snapshot_id_desktop": null,
        "desktop_size": 0,
        "snapshot_id_tablet": null,
        "tablet_size": 0,
        "snapshot_id_mobile": null,
        "mobile_size": 0,
        "name": "Example",
        "path": "/",
        "is_enabled": true,
        "datetime": "2026-09-13 06:04:06",
        "last_datetime": null
    }
}

Aggiornamento

POST https://hootmaps.com/api/heatmaps/{heatmap_id}
Parametri Dettagli Descrizione
name Facoltativo Traduci, ma evita di restituire punti finali: Stringa
is_enabled Facoltativo Intero Valori consentiti: 0, 1
curl --request POST \
--url 'https://hootmaps.com/api/heatmaps/{heatmap_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'is_enabled=1' \ 
{
    "data": {
        "id": 1,
        "website_id": 1,
        "user_id": 1,
        "snapshot_id_desktop": 1,
        "desktop_size": 123456,
        "snapshot_id_tablet": null,
        "tablet_size": 0,
        "snapshot_id_mobile": null,
        "mobile_size": 0,
        "name": "Example",
        "path": "/",
        "is_enabled": true,
        "datetime": "2026-09-13 06:04:06",
        "last_datetime": "2026-09-13 06:04:06"
    }
}

Elimina

DELETE https://hootmaps.com/api/heatmaps/{heatmap_id}
curl --request DELETE \
--url 'https://hootmaps.com/api/heatmaps/{heatmap_id}' \
--header 'Authorization: Bearer {api_key}' \