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

Exclua eventos de objetivo personalizado por visitante, nome do evento 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
visitorIdstringRemova objetivos vinculados a um identificador de visitante especifico.
namestringRemova objetivos correspondentes a um nome de evento especifico (por ex., signup, purchase).
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 intervalo de tempo:</strong> Remove todos os objetivos nesse periodo.

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

<strong>Apenas nome:</strong> Remove todos os objetivos com esse nome (todo o periodo).

<strong>Identificador de visitante + nome:</strong> Remove objetivos correspondentes a ambos os criterios.

<strong>Intervalo de tempo + filtros:</strong> Remove objetivos correspondentes aos filtros dentro da janela especificada.

Fornecer <code>visitorId</code> ou <code>name</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 por nome dentro de um intervalo de datas
curl -X DELETE "https://analytics.flowsery.com/analytics/api/v1/goals?websiteId=flid_abc123&name=signup&startAt=2024-01-01T00:00:00Z&endAt=2024-01-31T23:59:59Z" \
  -H "Authorization: Bearer <workspace-or-website-token>"
Excluir todos os objetivos de um visitante
curl -X DELETE "https://analytics.flowsery.com/analytics/api/v1/goals?websiteId=flid_abc123&visitorId=a3ab2331-989f-4cfa-91c6-2461c9e3c6bd" \
  -H "Authorization: Bearer <workspace-or-website-token>"
200
{
  "status": "success",
  "data": [
    {
      "deleted": 14,
      "message": "Goal events deleted successfully"
    }
  ]
}