Listar envios do site no Netlify, por uma API
Lista os envios de todos os formulários de um site, do mais recente ao mais antigo, com nome, email, os dados de cada campo e created_at. Pagine com page e per_page: uma página com menos itens que per_page é a última.
- Identificador
- netlify_list_site_submissions
A chamada
POST https://connect.reportei.com/api/tools/netlify_list_site_submissions/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>"
}
}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 | The id of the site from List sites, or its domain, such as mysite.netlify.app. |
| state | string | Não | Send spam for the submissions marked as spam. Without it, the verified ones.Valores: spam |
| per_page | integer | Não | Results per page, up to 100. |
| page | integer | Não | Page number, starting at 1. |
Conexões possíveis
O seu cliente conecta a conta do Netlify 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/netlify_list_site_submissions. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Netlify
- Listar sitesGETLista os sites (projetos, na interface da Netlify) que a conta alcança, com id, nome, url, custom_domain, o deploy publicado e as configurações de build. O id ou o domínio de um site é o site_id que as outras ferramentas recebem. Pagine com page e per_page: uma página com menos itens que per_page é a última.
- Atualizar sitePATCHAltera o nome ou os domínios de um site e o retorna. Só os campos enviados mudam. O DNS de um novo domínio personalizado ainda precisa apontar para a Netlify.
- Listar deploys do siteGETLista os deploys de um site, do mais recente ao mais antigo, com id, state, branch, context, error_message e a URL do deploy. Pagine com page e per_page: uma página com menos itens que per_page é a última.
- Obter deployGETRetorna um deploy, com state (ready quando está no ar ou pronto para publicar, error quando o build falhou), error_message, branch, commit_ref, published_at e a URL do deploy.
- Criar build do sitePOSTInicia um build de um site a partir do repositório conectado e retorna o build, com deploy_id para acompanhar em Obter deploy. Sem branch, faz o build de produção; outra branch gera um branch deploy. Espera na fila quando o time não tem capacidade de build livre.
- Cancelar deployPOSTInterrompe um deploy que ainda está na fila ou em build e o retorna.
- Restaurar deploy do sitePOSTPublica de novo um deploy anterior e o torna a versão no ar do site, que é como funciona um rollback. Retorna o deploy.
- Listar formulários do siteGETLista os formulários que a Netlify detectou em um site, com id, nome, campos e submission_count. Os envios em si vêm de Listar envios de um formulário.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
