Pular para o conteúdo principal
GET
Python (SDK)

Autorizações

Authorization
string
header
obrigatório

Gateway auth: send Authorization: Bearer <mka1-api-key>. For multi-user server-side integrations, you can also send X-On-Behalf-Of: <external-user-id>.

Cabeçalhos

X-On-Behalf-Of
string

Optional external end-user identifier forwarded by the API gateway.

Parâmetros de consulta

start_time
integer
obrigatório

Hora de início (segundos Unix), inclusiva

Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
Exemplo:

1704067200

end_time
integer

Hora de término (segundos Unix), exclusivo

Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
Exemplo:

1704153600

bucket_width
enum<string>
padrão:1d

Largura de cada intervalo de tempo (1m, 1h, 1d)

Opções disponíveis:
1m,
1h,
1d
Exemplo:

"1d"

limit
integer

Número de buckets a retornar

Intervalo obrigatório: 1 <= x <= 1440
Exemplo:

30

page
string

Cursor de paginação

Exemplo:

"cursor_abc123"

user_ids

Filtrar por IDs de usuários da plataforma (o mesmo grupo de dimensão group_by=user_id relatórios)

Exemplo:
external_user_ids

Filtrar por IDs de usuários finais delegados (externalUserId, ou seja, subs X-On-Behalf-Of)

Exemplo:
all_orgs
string

Uso agregado em todas as organizações (apenas administradores de cluster)

org_ids

Filtrar por IDs de organização (apenas administradores de cluster, implica escopo de cluster)

Exemplo:
group_by

Agrupar por campos especificados

Opções disponíveis:
user_id,
api_key_id,
org_id

Resposta

200 - application/json

OK

object
any
obrigatório
data
object[]
obrigatório
has_more
boolean
obrigatório

Whether there are more pages

next_page
string | null
obrigatório

Cursor for next page, null if no more pages