https://analytics.flowsery.com/analytics/api/v1/paymentsExclua registros de pagamento por identificador de transação, visitante ou dentro de um intervalo de datas.
Os tokens do espaço de trabalho precisam de um seletor de site
Os tokens da API do Workspace podem acessar todos os sites do workspace. PassewebsiteId ou domain para que Flowsery saiba qual site consultar ou alterar. As chaves da API do site já têm como escopo um site, portanto o seletor pode ser omitido.Seletor de site
| Parâmetro | Tipo | Descrição |
|---|---|---|
websiteId | string | ID do site a ser usado com um token de API do workspace. Omitir ao autenticar com uma chave de API de site. |
domain | string | Site domain para usar com um token de API do espaço de trabalho quando websiteId não for fornecido. Omitir ao autenticar com uma chave de API de site. |
Pelo menos um filtro obrigatório
Pelo menos um parâmetro de consulta deve ser fornecido. Chamar este endpoint sem filtros retorna um erro 400.Parâmetros de consulta
| Parâmetro | Tipo | Descrição |
|---|---|---|
transactionId | string | Remova o pagamento correspondente a um identificador de transação específico. |
visitorId | string | Remova todos os pagamentos vinculados a um identificador de visitante específico. |
startAt | string | Timestamp de início ISO 8601 (por ex., 2024-01-01T00:00:00Z). |
endAt | string | Timestamp de fim ISO 8601 (por ex., 2024-01-31T23:59:59Z). |
Comportamento de exclusão
<strong>Apenas identificador de transação:</strong> Remove o registro de pagamento específico.
<strong>Apenas identificador de visitante:</strong> Remove todos os pagamentos para esse visitante (todo o período).
<strong>Apenas intervalo de tempo:</strong> Remove todos os pagamentos nesse período.
<strong>Identificador de visitante + intervalo de tempo:</strong> Remove pagamentos do visitante dentro da janela.
<strong>Identificador de transação + intervalo de tempo:</strong> Remove a transação específica se estiver dentro do intervalo.
transactionId ou visitorId sem um intervalo de tempo exclui TODOS os registros correspondentes em todo o histórico.Respostas de erro
<strong>400 Bad Request</strong> -- Nenhum parâmetro de filtro foi fornecido.
<strong>401 Unauthorized</strong> – O token de API está ausente, é inválido, expirou ou não é aceito para este endpoint.
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"
}
]
}