https://analytics.flowsery.com/analytics/api/v1/paymentsEliminar registros de pago por ID de transacción, visitante o dentro de un rango de fechas.
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. PasewebsiteId o domain 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
| Parámetro | Tipo | Descripción |
|---|---|---|
websiteId | string | ID del sitio web para usar con un token de API del espacio de trabajo. Omitir al autenticarse con una clave API de sitio web. |
domain | string | Sitio 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 parámetro de consulta. Llamar a este endpoint sin filtros devuelve un error 400.Parámetros de consulta
| Parámetro | Tipo | Descripción |
|---|---|---|
transactionId | string | Eliminar el pago que coincida con un ID de transacción específico. |
visitorId | string | Eliminar todos los pagos vinculados a un ID de visitante específico. |
startAt | string | Marca de tiempo de inicio ISO 8601 (por ejemplo, 2024-01-01T00:00:00Z). |
endAt | string | Marca de tiempo de fin ISO 8601 (por ejemplo, 2024-01-31T23:59:59Z). |
Comportamiento de eliminación
<strong>Solo ID de transacción:</strong> Elimina el registro de pago específico.
<strong>Solo ID de visitante:</strong> Elimina todos los pagos de ese visitante (todo el periodo).
<strong>Solo rango de tiempo:</strong> Elimina todos los pagos dentro de ese periodo.
<strong>ID de visitante + rango de tiempo:</strong> Elimina los pagos del visitante dentro de la ventana.
<strong>ID de transacción + rango de tiempo:</strong> Elimina la transacción específica si cae dentro del rango.
transactionId o visitorId 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 parámetros 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.
curl -X DELETE "https://analytics.flowsery.com/analytics/api/v1/payments?websiteId=flid_abc123&transactionId=payment_456" \
-H "Authorization: Bearer <workspace-or-website-token>"curl -X DELETE "https://analytics.flowsery.com/analytics/api/v1/payments?visitorId=a3ab2331-989f-4cfa-91c6-2461c9e3c6bd&startAt=2024-01-01T00:00:00Z&endAt=2024-03-31T23:59:59Z" \
-H "Authorization: Bearer <workspace-or-website-token>"{
"status": "success",
"data": [
{
"deleted": 3,
"message": "Payments deleted successfully"
}
]
}