Saltar al contenido principal
GET
CSharp (SDK)

Autorizaciones

Authorization
string
header
requerido

Send Authorization: Bearer , using an MKA1 API key for automation or an OAuth API access token for a signed-in application. Use a dynamic security callback to refresh OAuth access tokens. Browser session-only operations still require their declared cookie.

Encabezados

X-On-Behalf-Of
string

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

Parámetros de consulta

start_time
integer
requerido

Hora de inicio (segundos Unix), inclusivo

Rango requerido: -9007199254740991 <= x <= 9007199254740991
Ejemplo:

1704067200

end_time
integer

Tiempo de finalización (segundos Unix), exclusivo

Rango requerido: -9007199254740991 <= x <= 9007199254740991
Ejemplo:

1704153600

bucket_width
enum<string>
predeterminado:1d

Ancho de cada intervalo de tiempo (1m, 1h, 1d), alineado con UTC

Opciones disponibles:
1m,
1h,
1d
Ejemplo:

"1d"

limit
integer

Número máximo de cubos por página, 1-1440. El valor predeterminado es 60 para cubos de 1m, 24 para 1h y 7 para 1d; los valores superiores a 168 para 1h o 31 para 1d se limitan a esos máximos. Cuando la ventana contiene más cubos, has_more es true y next_page continúa

Rango requerido: 1 <= x <= 1440
Ejemplo:

30

page
string

Cursor de la next_page de una página anterior. Reanuda en el bucket después de esa página; mantén todos los demás parámetros de consulta iguales. Un cursor emitido para otro start_time o bucket_width, o que reanuda fuera de [start_time, end_time), es un 400

Ejemplo:

"WzEsMTcwNDY3MjAwMCwiMWQiLDE3MDQwNjcyMDBd"

user_ids
string[]

Filtrar por IDs de usuario de plataforma (el mismo grupo de dimensión group_by=user_id informes)

Ejemplo:
external_user_ids
string[]

Filtrar por IDs de usuario final delegados (externalUserId, es decir, X-On-Behalf-Of subs)

Ejemplo:
all_orgs
string

Uso agregado en todas las organizaciones (solo administradores de clúster)

org_ids
string[]

Filtrar por IDs de organizaciones (solo administradores de clúster, implica alcance de clúster)

Ejemplo:
group_by
enum<string>[]

Agrupar por campos especificados

Opciones disponibles:
user_id,
api_key_id,
org_id,
model
models
string[]

Filtrar por nombres de modelo

Respuesta

200 - application/json

Está bien

object
any
requerido
data
object[]
requerido
has_more
boolean
requerido

True when the requested window holds more buckets than this page returned; fetch them with next_page

next_page
string | null
requerido

Cursor for the next page: pass it as page with the same query parameters to continue at the next bucket. Null on the last page

as_of
integer
requerido

Unix timestamp when these figures were computed. A cached report keeps the time it was computed, so this shows the report's age

Rango requerido: -9007199254740991 <= x <= 9007199254740991
settlement_window_seconds
integer
requerido

How long after it occurs usage stays provisional: 86400 (24 hours). Usage older than that is final and no longer changes

Rango requerido: -9007199254740991 <= x <= 9007199254740991
final_through
integer
requerido

Unix timestamp (as_of minus settlement_window_seconds) before which usage is final; usage at or after it is provisional

Rango requerido: -9007199254740991 <= x <= 9007199254740991
final
boolean
requerido

True when the whole requested window ends at or before final_through, so every figure in the report is final