Obter estatísticas agregadas de posts no beehiiv, por uma API

Retorna as estatísticas somadas dos posts de uma publicação que correspondem aos filtros: destinatários de email, entregas, aberturas, cliques, taxas, cancelamentos e denúncias de spam, visualizações e cliques na web e os links mais clicados. Em publicações grandes os números atualizam cerca de uma vez por hora, como mostra computed_at.

Identificador
beehiiv_get_post_aggregate_stats

A chamada

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

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

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
publicationIdstringSimId of the publication, from List publications.
statusstringNãoOnly posts in this status. The default is all.Valores: draft, confirmed, archived, all
platformstringNãoOnly posts published to web, to email or to both. The default is all.Valores: web, email, both, all
audiencestringNãoOnly posts for this audience. The default is all.Valores: free, premium, all
hidden_from_feedstringNãotrue only the posts hidden from the web feed, false only the visible ones.Valores: all, true, false

Conexões possíveis

O seu cliente conecta a conta do beehiiv 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/beehiiv_get_post_aggregate_stats. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do beehiiv

Ver as 12 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.