Skip to content
Roboto
Esc
↑↓navigate↵open⌘Jpreview

Get trigger evaluations

Access control

  • requires_resource_owner
  • Restricted tokens need the API scope api.everything_else
GET/v1/triggers/{trigger_name}/evaluations
Authorization
AuthorizationBearer token · headerrequired
Path parameters
trigger_namestringrequired
Query parameters
limitnumber
page_tokenstring
trigger_typestring
Header parameters
X-Roboto-Org-Idstring
X-Roboto-User-Idstring
Responses
200

OK

dataobjectrequired
Show properties
itemsTriggerEvaluationRecord[]required
Show properties
Array of TriggerEvaluationRecord
trigger_evaluation_idintegerrequired
trigger_idstringrequired
data_sourceInvocationDataSourcerequired

Abstracted data source that can be provided to an invocation.

Represents a source of input data for action invocations. The data source type determines how the ID should be interpreted (e.g., as a dataset ID).

Show properties
data_source_typeInvocationDataSourceTyperequired

Source of data for an action's input binding.

Defines the type of data source that provides input data to an action invocation. Currently supports datasets, with potential for future expansion to other data source types.

Allowed:Dataset
data_source_idstringrequired
data_constraintTriggerEvaluationDataConstraint | null
default: null
Show properties
Any of:
TriggerEvaluationDataConstraint
transaction_idstring | null
default: null
Show properties
Any of:
string
string
null
null
file_idstring | null
default: null
Show properties
Any of:
string
string
null
null
null
null
evaluation_startstring<date-time>required
evaluation_endstring<date-time> | null
default: null
Show properties
Any of:
string<date-time>
string<date-time>
null
null
statusTriggerEvaluationStatusrequired

When a trigger is selected for evaluation, a trigger evaluation record is created with a status of Pending. The evaluation can either run to completion (regardless of its outcome), in which case the status is Evaluated, or hit an unexpected exception, in which case the status is Failed.

Allowed:pendingevaluatedfailed
status_detailstring | null
default: null
Show properties
Any of:
string
string
null
null
outcomeTriggerEvaluationOutcome | null
default: null
Show properties
Any of:
TriggerEvaluationOutcome
string
null
null
outcome_reasonTriggerEvaluationOutcomeReason | null
default: null
Show properties
Any of:
TriggerEvaluationOutcomeReason
string
null
null
causeTriggerEvaluationCause | null
default: null
Show properties
Any of:
TriggerEvaluationCause
string
null
null
next_tokenstring | null
default: null
Show properties
Any of:
string
string
null
null
total_countinteger | null
default: null
Show properties
Any of:
integer
integer
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
Authorization
Parameters
Request
curl -X GET 'https://api.roboto.ai/v1/triggers/string/evaluations' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "data": {
    "items": [
      {
        "trigger_evaluation_id": 0,
        "trigger_id": "string",
        "data_source": {
          "data_source_type": "Dataset",
          "data_source_id": "string"
        },
        "data_constraint": null,
        "evaluation_start": "2019-08-24T14:15:22Z",
        "evaluation_end": null,
        "status": "pending",
        "status_detail": null,
        "outcome": null,
        "outcome_reason": null,
        "cause": null
      }
    ],
    "next_token": null,
    "total_count": null
  }
}