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

Eliminar registros de pago por ID de transacción, visitante 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 websiteId 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ámetroTipoDescripción
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 parámetro de consulta. Llamar a este endpoint sin filtros devuelve un error 400.

Parámetros de consulta

ParámetroTipoDescripción
transactionIdstringEliminar el pago que coincida con un ID de transacción específico.
visitorIdstringEliminar todos los pagos vinculados a un ID de visitante específico.
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 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.

Proporcionar 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.

Eliminar una transacción específica
curl -X DELETE "https://analytics.flowsery.com/analytics/api/v1/payments?websiteId=flid_abc123&transactionId=payment_456" \
  -H "Authorization: Bearer <workspace-or-website-token>"
Eliminar pagos de un visitante en un rango de fechas
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>"
200
{
  "status": "success",
  "data": [
    {
      "deleted": 3,
      "message": "Payments deleted successfully"
    }
  ]
}