Obter estatísticas de crescimento no Kit, por uma API

Retorna os inscritos no fim do período, os novos inscritos, os cancelamentos e o saldo de novos inscritos entre starting e ending, contados no fuso horário de envio da conta. O período padrão são os últimos 90 dias.

Identificador
kit_get_growth_stats

A chamada

POST https://connect.reportei.com/api/tools/kit_get_growth_stats/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "starting": "<starting>"
  }
}

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âmetroTipoObrigatórioDescrição
startingstringNãoFirst day of the period, as YYYY-MM-DD. The default is 90 days ago.
endingstringNãoLast day of the period, as YYYY-MM-DD. The default is today.

Conexões possíveis

O seu cliente conecta a conta do Kit uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

OAuth com o app do seu produto

Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/kit, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.

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/kit_get_growth_stats. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Kit

Ver as 13 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.