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

Usuwa rekordy płatności według identyfikatora transakcji, odwiedzającego lub zakresu dat.

Bearer Token (token obszaru roboczego lub klucz API witryny)

Tokeny obszaru roboczego wymagają wskazania witryny

Tokeny API obszaru roboczego mają dostęp do wszystkich witryn w obszarze. Należy przekazać websiteId lub domain, aby Flowsery wiedziało, której witryny dotyczy zapytanie lub zmiana. Klucze API witryn są już przypisane do jednej witryny, więc można to pominąć.

Wskazanie witryny

ParametrTypOpis
websiteIdstringID witryny używane z tokenem API obszaru roboczego. Należy pominąć przy uwierzytelnianiu kluczem API witryny.
domainstringDomena witryny używana z tokenem API obszaru roboczego, gdy nie podano websiteId. Należy pominąć przy uwierzytelnianiu kluczem API witryny.

Wymagany co najmniej jeden filtr

Należy podać co najmniej jeden parametr zapytania. Wywołanie bez filtrów zwraca błąd 400.

Parametry zapytania

ParametrTypOpis
transactionIdstringUsuwa płatność o danym identyfikatorze transakcji.
visitorIdstringUsuwa wszystkie płatności powiązane z danym identyfikatorem odwiedzającego.
startAtstringZnacznik czasu początku w ISO 8601 (np. 2024-01-01T00:00:00Z).
endAtstringZnacznik czasu końca w ISO 8601 (np. 2024-01-31T23:59:59Z).

Działanie usuwania

<strong>Tylko ID transakcji:</strong> usuwa dany rekord płatności.

<strong>Tylko ID odwiedzającego:</strong> usuwa wszystkie płatności tego odwiedzającego (z całego okresu).

<strong>Tylko zakres czasu:</strong> usuwa wszystkie płatności z tego okresu.

<strong>ID odwiedzającego + zakres czasu:</strong> usuwa płatności odwiedzającego w podanym okresie.

<strong>ID transakcji + zakres czasu:</strong> usuwa daną transakcję, jeśli mieści się w zakresie.

Podanie transactionId lub visitorId bez zakresu czasu usuwa WSZYSTKIE pasujące rekordy z całej historii.

Odpowiedzi z błędami

<strong>400 Bad Request</strong> -- Nie podano parametrów filtrowania.

<strong>401 Unauthorized</strong> -- Token API jest nieobecny, nieprawidłowy, wygasł lub nie jest akceptowany przez ten punkt końcowy.

Usuwanie konkretnej transakcji
curl -X DELETE "https://analytics.flowsery.com/analytics/api/v1/payments?websiteId=flid_abc123&transactionId=payment_456" \
  -H "Authorization: Bearer <workspace-or-website-token>"
Usuwanie płatności odwiedzającego w zakresie dat
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"
    }
  ]
}