Skip to main content
GET
Métrica de engajamento agregada do período, sem granularidade de criança — planejado

Authorizations

Authorization
string
header
required

Client credentials, escopado ao HistorinhAI — ver /oauth2/token acima (planejado: hoje o emissor que existe é o da Platform API, em https://api.googa.com.br/v1/oauth2/token).

Query Parameters

period_start
string<date>
required
period_end
string<date>
required

Janela máxima suportada: 366 dias. Recomendamos alinhar ao ciclo mensal da Nota de Débito da Platform API para facilitar a correlação com billing.

Response

Resumo do período (possivelmente suprimido pelo piso de amostra).

Todo campo numérico é um agregado sobre a base completa de contas do parceiro no período — nunca uma lista, nunca uma linha por conta ou por criança.

period_start
string<date>
period_end
string<date>
active_accounts
integer | null

Contas do parceiro com ao menos um entitlement HistorinhAI ativo em algum momento do período. null se abaixo do piso de amostra.

stories_completed
integer | null

Total de histórias concluídas por qualquer criança de qualquer conta do parceiro no período, somado sem distinção de conta ou criança. null se abaixo do piso de amostra.

avg_minutes_per_active_account
number | null

Minutos lidos no período, somados por conta e depois em média entre contas.

min_sample_threshold
integer

Piso mínimo de active_accounts exigido para retornar os campos acima.

Example:

30

suppressed
boolean

true quando os campos numéricos foram omitidos por estarem abaixo do piso de amostra.

generated_at
string<date-time>