Agrega uma coorte por propriedade ou relação
Agrega a mesma coorte de `rankObjects`, recortada por `kind`, `subkind`, relações e `where`. `group_by` aceita propriedade ou relação; `meta.group_by_kind` identifica o caso e grupos relacionais trazem `entity_id`. Use `group_by_direction` para indicar onde a coorte está na aresta. `sum` é recusado para percentual, razão, múltiplo e ponto de índice; `avg`, `median`, `min` e `max` preservam a unidade. Sem `fact`, `agg=count` conta objetos. `cohort_objects`, `cohort_with_value`, `ungrouped` e `multi_group` mostram cobertura e sobreposição; ausência de valor produz `null`, nunca zero. Leia o total da coorte em `meta.cohort_value`, não somando a página. `cursor` pagina os grupos, `q` filtra seus rótulos e `order_by` escolhe ordenar pelo valor ou pelo número de objetos.
In: header
Query Parameters
O tipo dos objetos que entram na coorte.
"company" | "equity_security" | "fund" | "service_provider" | "instrument" | "index" | "crypto_asset" | "commodity" | "country" | "indicator" | "data_series" | "offering" | "fund_share_class" | "market_event" | "role" | "sector" | "securitization" | "norm"Recorte dentro do tipo.
Medida a resumir, pelo nome de listFactCatalog. Omita com agg=count para contar objetos por grupo, o único caminho para tipos que só têm propriedades.
Redução por grupo. sum é recusado em pct, ratio, x e points. count conta objetos com valor na medida; sem fact, conta todos os objetos do grupo.
"sum" | "avg" | "median" | "min" | "max" | "count"Eixo do agrupamento: propriedade (situation), relação (manages, com group_by_direction) ou balde de tempo (year, quarter, month, que exigem fact). meta.groupable lista as opções e meta.group_by_kind informa a usada.
Lado da coorte na aresta quando group_by é relação, como em rel_direction. Direção errada devolve lista vazia e meta.empty_reason indica a correta.
"out""in" | "out"Data-base dos valores e vigência das relações da coorte. Sem at, usa o valor mais recente por objeto e o acervo histórico das relações, como listObjectLinks. Com fact, verbo de estado no rel (manages, audits) é lido como vigente e declarado em meta.current_state_rels; no censo sem fact a data passada é recusada.
^\d{4}-\d{2}-\d{2}$Restringe a coorte a quem tem esta relação com rel_to.
O outro lado de rel.
Onde a coorte está na aresta de rel.
"in""in" | "out"Os mesmos cortes de rankObjects, por número e por palavra, aplicados antes do agrupamento.
Grupos por página (1–200, default 50).
501 <= value <= 200Cursor de meta.next_cursor da página anterior de grupos.
Busca no rótulo do grupo, sem acento nem caixa. meta.total_groups conta só os que casam.
2 <= length <= 120Ordena e corta a página pela agregação (value) ou pelo número de objetos do grupo (objects).
"value""value" | "objects"Data-base mínima aceita no valor, como em rankObjects. Sem ela, a cadência da medida define o piso e meta.stale_excluded conta os objetos parados que ficaram fora. meta.since e since_policy informam o corte efetivo.
^\d{4}-\d{2}-\d{2}$Exclui da agregação os valores fora da faixa plausível declarada para fact. meta.excluded_out_of_prior informa quantos valores saíram; vem nulo quando o filtro não foi pedido ou a medida não declara faixa. No censo sem fact, não há medida a validar.
Response Body
curl -X GET "https://api.databolsa.com/v1/objects/aggregate?kind=company&subkind=string&fact=string&agg=sum&group_by=string&group_by_direction=in&at=string&rel=string&rel_to=string&rel_direction=in&where=string&limit=50&cursor=string&q=string&order_by=value&since=string&exclude_out_of_prior=true"{
"data": [
{
"key": "string",
"label": "string",
"entity_id": "string",
"value": 0,
"objects": 0,
"with_value": 0
}
],
"meta": {
"next_cursor": "string",
"count": 0,
"fact": "string",
"unit": "brl",
"agg": "sum",
"group_by": "string",
"group_by_kind": "property",
"source": "string",
"cadence": "daily",
"grain": "object",
"description": "string",
"cohort_objects": 0,
"cohort_with_value": 0,
"cohort_value": 0,
"excluded_out_of_prior": 0,
"since": "string",
"since_policy": "caller",
"stale_excluded": 0,
"order_by": "value",
"total_groups": 0,
"groups_truncated": true,
"current_state_rels": [
"string"
],
"ungrouped": 0,
"multi_group": 0,
"filterable_properties": [
{
"name": "string",
"vocabulary": [
"string"
]
}
],
"groupable": [
{
"name": "string",
"kind": "property"
}
],
"empty_reason": "string"
}
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"details": {
"property1": null,
"property2": null
}
}Visão geral
Referência completa da API pública do DataBolsa, gerada do contrato OpenAPI.
Descobre como dois objetos se conectam
Descobre cadeias entre dois objetos; use `traverseObjectPath` quando a cadeia já for conhecida. Agrupa resultados por cadeia, traz intermediários em `examples` e conta sequências distintas em `path_count`, sem duplicar fontes. Cadeias curtas vêm primeiro. O padrão é dois saltos; o terceiro é mais caro.