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

Exclua registros de pagamento por identificador de transacao, visitante ou dentro de um intervalo de datas.

Token Bearer (token de workspace ou chave API de website)

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. Passe <code>websiteId</code> ou <code>domain</code> 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

ParametroTipoDescricao
websiteIdstringID do site a ser usado com um token de API do workspace. Omitir ao autenticar com uma chave de API de site.
domainstringSite 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 obrigatorio

Pelo menos um parametro de consulta deve ser fornecido. Chamar este endpoint sem filtros retorna um erro 400.

Parametros de consulta

ParametroTipoDescricao
transactionIdstringRemova o pagamento correspondente a um identificador de transacao especifico.
visitorIdstringRemova todos os pagamentos vinculados a um identificador de visitante especifico.
startAtstringTimestamp de inicio ISO 8601 (por ex., 2024-01-01T00:00:00Z).
endAtstringTimestamp de fim ISO 8601 (por ex., 2024-01-31T23:59:59Z).

Comportamento de exclusao

<strong>Apenas identificador de transacao:</strong> Remove o registro de pagamento especifico.

<strong>Apenas identificador de visitante:</strong> Remove todos os pagamentos para esse visitante (todo o periodo).

<strong>Apenas intervalo de tempo:</strong> Remove todos os pagamentos nesse periodo.

<strong>Identificador de visitante + intervalo de tempo:</strong> Remove pagamentos do visitante dentro da janela.

<strong>Identificador de transacao + intervalo de tempo:</strong> Remove a transacao especifica se estiver dentro do intervalo.

Fornecer <code>transactionId</code> ou <code>visitorId</code> sem um intervalo de tempo exclui TODOS os registros correspondentes em todo o historico.

Respostas de erro

<strong>400 Bad Request</strong> -- Nenhum parametro de filtro foi fornecido.

<strong>401 Unauthorized</strong> – O token de API está ausente, é inválido, expirou ou não é aceito para este endpoint.

Excluir uma transacao especifica
curl -X DELETE "https://analytics.flowsery.com/analytics/api/v1/payments?websiteId=flid_abc123&transactionId=payment_456" \
  -H "Authorization: Bearer <workspace-or-website-token>"
Excluir pagamentos de um visitante em um intervalo de datas
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": "Payment records deleted successfully"
    }
  ]
}