Goals

Recupera todos

GET https://hootmaps.com/api/goals/
curl --request GET \
--url 'https://hootmaps.com/api/goals/' \
--header 'Authorization: Bearer {api_key}' \
Parámetros Detalles Descripción
website_id Opcional Entero
type Opcional Traduzca, pero evite devolver puntos finales: Cadena Valores permitidos: pageview, custom, scroll
search Opcional Traduzca, pero evite devolver puntos finales: Cadena La cadena de búsqueda
search_by Opcional Traduzca, pero evite devolver puntos finales: Cadena En qué campo estás buscando. Los valores permitidos son: name, path, key
datetime_field Opcional Traduzca, pero evite devolver puntos finales: Cadena Valores permitidos: datetime, last_datetime
datetime_start Opcional Traduzca, pero evite devolver puntos finales: Cadena Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end Opcional Traduzca, pero evite devolver puntos finales: Cadena Filter results up to this datetime. Y-m-d H:i:s format.
order_by Opcional Traduzca, pero evite devolver puntos finales: Cadena Campo por el cual ordenar los resultados. Los valores permitidos son: goal_id, last_datetime, datetime, name, path, key, scroll_percentage
order_type Opcional Traduzca, pero evite devolver puntos finales: Cadena El ordenamiento de los resultados. Los valores permitidos son: ASC para ordenamiento ascendente y DESC para ordenamiento descendente
page Opcional Entero El número de página del que deseas obtener resultados. Por defecto es 1
results_per_page Opcional Entero Cuántos resultados deseas por página. Los valores permitidos son: 10, 25, 50, 100, 250, 500, 1000. Por defecto es 25 
{
    "data": [
        {
            "id": 1,
            "website_id": 1,
            "user_id": 1,
            "key": "123456789",
            "type": "custom",
            "path": null,
            "scroll_percentage": null,
            "name": "Example",
            "last_datetime": null,
            "datetime": "2026-09-13 06:07:04"
        }
    ],
    "meta": {
        "page": 1,
        "total_pages": 1,
        "results_per_page": 25,
        "total_results": 1
    },
    "links": {
        "first": "https://hootmaps.com/api/goals?page=1",
        "last": "https://hootmaps.com/api/goals?page=1",
        "next": null,
        "prev": null,
        "self": "https://hootmaps.com/api/goals?page=1"
    }
}

Recuperar uno

GET https://hootmaps.com/api/goals/{goal_id}
curl --request GET \
--url 'https://hootmaps.com/api/goals/{goal_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "website_id": 1,
        "user_id": 1,
        "key": "123456789",
        "type": "custom",
        "path": null,
        "scroll_percentage": null,
        "name": "Example",
        "last_datetime": null,
        "datetime": "2026-09-13 06:07:04"
    }
}

Crear

POST https://hootmaps.com/api/goals
Parámetros Detalles Descripción
website_id Requerido Entero -
type Requerido Traduzca, pero evite devolver puntos finales: Cadena Valores permitidos: pageview, custom, scroll
name Requerido Traduzca, pero evite devolver puntos finales: Cadena -
path Opcional Traduzca, pero evite devolver puntos finales: Cadena Available when: type = pageview, scroll
scroll_percentage Opcional Entero Available when: type = scroll
key Opcional Traduzca, pero evite devolver puntos finales: Cadena -
curl --request POST \
--url 'https://hootmaps.com/api/goals' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'website_id=1' \
--form 'name=Example' \
--form 'type=scroll' \
--form 'path=blog/*' \
--form 'scroll_percentage=75' \
{
    "data": {
        "id": 1,
        "website_id": 1,
        "user_id": 1,
        "key": "123456789",
        "type": "scroll",
        "path": "/blog/*",
        "scroll_percentage": 75,
        "name": "Example",
        "last_datetime": null,
        "datetime": "2026-09-13 06:07:04"
    }
}

Actualización

POST https://hootmaps.com/api/goals/{goal_id}
Parámetros Detalles Descripción
website_id Opcional Entero -
type Opcional Traduzca, pero evite devolver puntos finales: Cadena Valores permitidos: pageview, custom, scroll
name Opcional Traduzca, pero evite devolver puntos finales: Cadena -
path Opcional Traduzca, pero evite devolver puntos finales: Cadena Available when: type = pageview, scroll
scroll_percentage Opcional Entero Available when: type = scroll
key Opcional Traduzca, pero evite devolver puntos finales: Cadena -
curl --request POST \
--url 'https://hootmaps.com/api/goals/{goal_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'type=scroll' \
--form 'path=blog/*' \
--form 'scroll_percentage=75' \
{
    "data": {
        "id": 1,
        "website_id": 1,
        "user_id": 1,
        "key": "123456789",
        "type": "scroll",
        "path": "/blog/*",
        "scroll_percentage": 75,
        "name": "Example",
        "last_datetime": "2026-09-13 06:07:04",
        "datetime": "2026-09-13 06:07:04"
    }
}

Eliminar

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