api-referenceDEL
DELETEhttps://analytics.flowsery.com/analytics/api/v1/goals

Eliminar eventos de objetivos personalizados por visitante, nombre de evento o dentro de un rango de fechas.

Token Bearer (token de workspace o clave API de sitio web)

Los tokens de espacio de trabajo necesitan un selector de sitio web

Los tokens de API del espacio de trabajo pueden acceder a todos los sitios web del espacio de trabajo. Pase <code>websiteId</code> o <code>domain</code> para que Flowsery sepa qué sitio web consultar o mutar. Las claves API del sitio web ya están destinadas a un sitio web, por lo que se puede omitir el selector.

Selector de sitios web

ParametroTipoDescripcion
websiteIdstringID del sitio web para usar con un token de API del espacio de trabajo. Omitir al autenticarse con una clave API de sitio web.
domainstringSitio web domain para usar con un token API de espacio de trabajo cuando no se proporciona websiteId. Omitir al autenticarse con una clave API de sitio web.

Se requiere al menos un filtro

Se debe proporcionar al menos un parametro de consulta. Llamar a este endpoint sin filtros devuelve un error 400.

Parametros de consulta

ParametroTipoDescripcion
visitorIdstringEliminar objetivos vinculados a un ID de visitante especifico.
namestringEliminar objetivos que coincidan con un nombre de evento especifico (por ejemplo, signup, purchase).
startAtstringMarca de tiempo de inicio ISO 8601 (por ejemplo, 2024-01-01T00:00:00Z).
endAtstringMarca de tiempo de fin ISO 8601 (por ejemplo, 2024-01-31T23:59:59Z).

Comportamiento de eliminacion

<strong>Solo rango de tiempo:</strong> Elimina todos los objetivos dentro de ese periodo.

<strong>Solo ID de visitante:</strong> Elimina todos los objetivos de ese visitante (todo el periodo).

<strong>Solo nombre:</strong> Elimina todos los objetivos con ese nombre (todo el periodo).

<strong>ID de visitante + nombre:</strong> Elimina los objetivos que coincidan con ambos criterios.

<strong>Rango de tiempo + filtros:</strong> Elimina los objetivos que coincidan con los filtros dentro de la ventana dada.

Proporcionar <code>visitorId</code> o <code>name</code> sin un rango de tiempo elimina TODOS los registros coincidentes de todo el historial.

Respuestas de error

<strong>400 Bad Request</strong> -- No se proporcionaron parametros de filtro.

<strong>401 Unauthorized</strong>: falta el token de API, no es válido, ha caducado o no se acepta para este punto final.

Eliminar por nombre dentro de un rango de fechas
curl -X DELETE "https://analytics.flowsery.com/analytics/api/v1/goals?websiteId=flid_abc123&name=signup&startAt=2024-01-01T00:00:00Z&endAt=2024-01-31T23:59:59Z" \
  -H "Authorization: Bearer <workspace-or-website-token>"
Eliminar todos los objetivos de un visitante
curl -X DELETE "https://analytics.flowsery.com/analytics/api/v1/goals?websiteId=flid_abc123&visitorId=a3ab2331-989f-4cfa-91c6-2461c9e3c6bd" \
  -H "Authorization: Bearer <workspace-or-website-token>"
200
{
  "status": "success",
  "data": [
    {
      "deleted": 14,
      "message": "Goal events deleted successfully"
    }
  ]
}