Aggregate metric

Access control

requires_resource_owner
Restricted tokens need the API scope api.everything_else

POST/v1/metrics/aggregate

Authorization

AuthorizationBearer token · headerrequired

Header parameters

X-Roboto-Org-Idstring

X-Roboto-User-Idstring

Request body

requiredapplication/json

namestringrequired

periodAggregationPeriodrequired

Calendar bucket size used when grouping metric observations.

All aggregation start/end times are based on UTC time.

Allowed:dailyweeklymonthlyquarterlyyearly

aggregationNumericAggregationrequired

Aggregation function applied to numeric metric values within each period bucket.

Allowed:summeanmaxmincount

time_filterMetricTimeFilter

Allowed:start_timeend_time

start_time_nsintegerrequired

end_time_nsintegerrequired

include_device_idsstring[] | null

Show properties

Any of:

string[]

Array of string

string

null

null

null

null

include_session_idsstring[] | null

Show properties

Any of:

string[]

Array of string

string

null

null

include_invocation_idsstring[] | null

Show properties

Any of:

string[]

Array of string

string

null

null

null

null

conditionCondition | ConditionGroup | null

default: null

Show properties

Any of:

Condition

fieldstringrequired

comparatorComparatorrequired

The comparator to use when comparing a field to a value.

Allowed:EQUALSNOT_EQUALSGREATER_THANGREATER_THAN_OR_EQUALLESS_THANLESS_THAN_OR_EQUALCONTAINSNOT_CONTAINSIS_NULLIS_NOT_NULLEXISTSNOT_EXISTSBEGINS_WITHLIKENOT_LIKE

default: null

Show properties

Any of:

string

string

boolean

boolean

integer

integer

number

number

string

string

string<date-time>

string<date-time>

null

null

ConditionGroup

operatorConditionOperatorrequired

The operator to use when combining multiple conditions.

Allowed:ANDORNOT

conditionsCondition | ConditionGroup[]required

Show properties

Array of Condition | ConditionGroup

Any of:

Condition

fieldstringrequired

comparatorComparatorrequired

The comparator to use when comparing a field to a value.

Allowed:EQUALSNOT_EQUALSGREATER_THANGREATER_THAN_OR_EQUALLESS_THANLESS_THAN_OR_EQUALCONTAINSNOT_CONTAINSIS_NULLIS_NOT_NULLEXISTSNOT_EXISTSBEGINS_WITHLIKENOT_LIKE

default: null

Show properties

Any of:

string

string

boolean

boolean

integer

integer

number

number

string

string

string<date-time>

string<date-time>

null

null

ConditionGroup

Circular reference to ConditionGroup.

null

null

group_bystring | null

default: null

Show properties

Any of:

string

string

null

null

Responses

200

dataobjectrequired

Response payload for a numeric metric aggregation request.

Show properties

aggregationNumericAggregationrequired

Aggregation function applied to numeric metric values within each period bucket.

Allowed:summeanmaxmincount

recordsNumericAggregateMetricRecord[]required

Show properties

Array of NumericAggregateMetricRecord

metric_idstringrequired

namestringrequired

periodAggregationPeriodrequired

Calendar bucket size used when grouping metric observations.

All aggregation start/end times are based on UTC time.

Allowed:dailyweeklymonthlyquarterlyyearly

start_timeintegerrequired

end_timeintegerrequired

totalintegerrequired

valuenumberrequired

unitstring | null

default: null

Show properties

Any of:

string

string

null

null

aggregationNumericAggregationrequired

Aggregation function applied to numeric metric values within each period bucket.

Allowed:summeanmaxmincount

group_keystring | null

default: null

Show properties

Any of:

string

string

null

null

400

Thrown when the conversation context (messages, system prompt, tool results) exceeds the model's context window limit.

The token estimate and the model's context limit are not carried on the exception, so a caller cannot read usage numbers off it.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

401

Thrown when authentication fails

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

403

Thrown if an operation would exceed a user or org level limit.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

404

Thrown if a user is attempting to perform an action unrecognized by the Roboto platform.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

409

Thrown if there is a conflict between a resource you're creating and another existing resource

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

410

Thrown if a resource is missing or expired.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

500

An error the platform reported that this SDK release cannot resolve to a specific exception class.

Reported for an element of a :py:class:~roboto.http.BatchResponse whose error names a code this release defines no class for, or that arrived without a code, without a message, or as text that is not an error envelope at all. It carries whatever code and message the platform sent, so a caller handling the failure still learns what went wrong; when no message could be read, the message is the error's raw text.

The error envelope carries no status code, so http_status_code reports the 500 inherited from :py:class:RobotoDomainException rather than the status the failure actually had.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

501

Thrown by shimmed out APIs which have not yet been implemented

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

503

Thrown when a service is unavailable, such as when it's under heavy load and can't accept new requests. This is expected to be transient and ought to be retried.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

504

Thrown when the service times out while processing a request. This is exepcted to be transient and ought to be retried.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

507

Thrown when the server cannot complete the request because the response payload exceeds a storage or transport capacity limit (e.g., Lambda response size). This is NOT expected to be transient and should NOT be retried.

errorobject

Show properties

error_codenumber

messagestring

stack_tracestring | null

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

X-Roboto-Org-IdheaderX-Roboto-User-Idheader

Bodyapplication/json

namestring*periodstring*Calendar bucket size used when grouping metric observations. All aggregation start/end times are based on UTC time.aggregationstring*Aggregation function applied to numeric metric values within each period bucket.time_filterstringstart_time_nsinteger*end_time_nsinteger*include_device_idsstringinclude_session_idsstringinclude_invocation_idsstringconditionstringgroup_bystring

Request

curl -X POST 'https://api.roboto.ai/v1/metrics/aggregate' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "period": "daily",
  "aggregation": "sum",
  "time_filter": "start_time",
  "start_time_ns": 0,
  "end_time_ns": 0,
  "include_device_ids": [
    "string"
  ],
  "include_session_ids": [
    "string"
  ],
  "include_invocation_ids": [
    "string"
  ],
  "condition": null,
  "group_by": null
}'

const response = await fetch("https://api.roboto.ai/v1/metrics/aggregate", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"period\": \"daily\",\n  \"aggregation\": \"sum\",\n  \"time_filter\": \"start_time\",\n  \"start_time_ns\": 0,\n  \"end_time_ns\": 0,\n  \"include_device_ids\": [\n    \"string\"\n  ],\n  \"include_session_ids\": [\n    \"string\"\n  ],\n  \"include_invocation_ids\": [\n    \"string\"\n  ],\n  \"condition\": null,\n  \"group_by\": null\n}"
});

import requests

response = requests.post(
    "https://api.roboto.ai/v1/metrics/aggregate",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"period\": \"daily\",\n  \"aggregation\": \"sum\",\n  \"time_filter\": \"start_time\",\n  \"start_time_ns\": 0,\n  \"end_time_ns\": 0,\n  \"include_device_ids\": [\n    \"string\"\n  ],\n  \"include_session_ids\": [\n    \"string\"\n  ],\n  \"include_invocation_ids\": [\n    \"string\"\n  ],\n  \"condition\": null,\n  \"group_by\": null\n}",
)

Response

{
  "data": {
    "aggregation": "sum",
    "records": [
      {
        "metric_id": "string",
        "name": "string",
        "period": "daily",
        "start_time": 0,
        "end_time": 0,
        "total": 0,
        "value": 0,
        "unit": null,
        "aggregation": "sum",
        "group_key": null
      }
    ]
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}

{
  "error": {
    "error_code": 0,
    "message": "string",
    "stack_trace": "string"
  }
}