Atualizar marco no Fathom Analytics, por uma API
Altera um marco. Envie name e milestone_date, mesmo o que não muda.
- Identificador
- fathom_update_milestone
A chamada
POST https://connect.reportei.com/api/tools/fathom_update_milestone/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"site_id": "<site_id>",
"milestone_id": "<milestone_id>",
"name": "<name>",
"milestone_date": "<milestone_date>"
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| site_id | string | Sim | Id of the site, from List sites. It is the code of the tracking script, for example CDBUGS. |
| milestone_id | string | Sim | Id of the milestone, a UUID, from List milestones. |
| name | string | Sim | Name of the milestone, up to 30 characters. |
| milestone_date | string | Sim | Date of the milestone as YYYY-MM-DD. |
Conexões possíveis
O seu cliente conecta a conta do Fathom Analytics uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/fathom_update_milestone. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Fathom Analytics
- Listar sitesGETLista os sites da conta com id, name, sharing e timezone, do mais antigo ao mais novo. O id é o código do script de rastreamento que as outras ferramentas pedem. Enquanto has_more for true, envie o id do último site como starting_after.
- Obter siteGETRetorna um site com nome, sharing, fuso horário e data de criação.
- Criar sitePOSTCria um site e o retorna com o id para colocar no script de rastreamento. Precisa de um token com a permissão Admin.
- Atualizar sitePOSTAltera um site. Só os campos enviados mudam.
- Listar eventosGETLista todos os nomes de evento que o site rastreou, com a moeda de cada um, ordenados por nome. Os relatórios de um evento usam o nome; o id só funciona como cursor de página. Enquanto has_more for true, envie o id do último evento como starting_after.
- Obter agregaçãoGETMonta um relatório personalizado sobre os pageviews de um site ou sobre um evento: totais, ou agrupados por período e por campos como pathname, referrer_source ou utm_campaign. Os números voltam como texto e não há paginação: relatórios agrupados retornam até 500 linhas, a menos que limit diga outro valor.
- Obter visitantes atuaisGETRetorna quantas pessoas estão no site agora. Com detailed, também as 150 páginas e as 150 origens principais.
- Listar marcosGETLista os marcos do site, as datas marcadas nos relatórios, do mais antigo ao mais novo. Enquanto has_more for true, envie o id do último marco como starting_after.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
