Event Streams APIs

The API returns information for a specific environment or account.

Currently, you can only use the API for Administration functions like Provisions, Querying metrics, Create/Update/Delete Subscriptions and Topics. The Admin APIs cannot produce or consume messages. To produce messages, refer to the Event Streams REST API topic.

Supported categories

Operation	QUERY	MUTATION
EventStreamsTopic	✅ Supported	✅ Supported
EventStreamsToken	Not Supported	✅ Supported
EventStreamsSubscription	✅ Supported	✅ Supported
EventStreamsMessages	✅ Supported	✅ Supported
EventStreamsMessageManagement	✅ Supported	✅ Supported
EventStreamsTopicMetrics	✅ Supported	Not Supported
EventStreamsSubscriptionMetrics	✅ Supported	Not Supported
Environment	✅ Supported	Not Supported
Regions	✅ Supported	Not Supported

Error Codes

Field	Description
TENANT\_NOT\_FOUND	The tenant does not exist.
TOPIC\_NOT\_FOUND	The topic does not exist.
DATE\_PARSE\_ERROR	Unable to parse date.
TOPIC\_PROPERTIES\_NOT\_FOUND	Topic properties do not exist.
NOT\_PROVISIONED	The specified account is not provisioned.
ACCOUNT\_NOT\_FOUND	The specified account does not exist.
SUBSCRIPTION\_NOT\_FOUND	The subscription does not exist.
ENVIRONMENT\_NOT\_FOUND	The environment does not exist.
INVALID\_NAME	Invalid name.
INVALID\_DESCRIPTION	Invalid description, only 500 characters allowed.
TOPIC\_ALREADY\_EXISTS	The specified topic already exists.
SUBSCRIPTION\_ALREADY\_EXISTS	The The specified subscription already exists.

Event Streams Query Error Codes

Field	Description
ROW\_LIMIT\_EXCEEDED	The Row Limit Exceeded exception is returned when the row-limit of {0} was exceeded for the query.
INVALID\_TIME\_RANGE	The Invalid Time Range exception is returned when the requestTSend {1} value is not greater than the requestTStart {0} value.
EXCEEDED\_TIME\_BUCKET\_LIMIT	The Exceeded Time Bucket Limit is returned when the calculated number of time buckets, {0}, is greater than the maximum allowed number of time buckets, {1}.