> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Get the streaming event manifest > Returns the static catalog of business events Reporter can publish without disclosing broker topology. ## OpenAPI ````yaml /pt/openapi/v3-current/reporter.yaml get /v1/streaming/events openapi: 3.1.0 info: contact: email: contact@lerian.studio name: Lerian Studio url: https://lerian.studio description: >- Reporter generates regulatory, accounting and operational reports from templates over your data sources. license: name: Lerian Studio General License title: Reporter API version: 4.0.0 servers: - url: https://reporter.sandbox.lerian.net security: - BearerAuth: [] tags: - description: Generated report instances and their lifecycle. name: Reports - description: Reusable report definitions. name: Templates - description: Interactive construction of report templates. name: Template Builder - description: Scheduled report due-date tracking. name: Deadlines - description: Configured inputs that feed report data. name: Data Sources - description: Aggregated reporting metrics. name: Metrics - description: Published business event catalog and delivery policies. name: Streaming paths: /v1/streaming/events: get: tags: - Streaming summary: Get the streaming event manifest description: >- Returns the static catalog of business events Reporter can publish without disclosing broker topology. operationId: getStreamingEvents responses: '200': content: application/json: schema: $ref: '#/components/schemas/StreamingManifestHumaResponse' description: OK headers: Cache-Control: schema: description: >- Prevents intermediaries and clients from storing the manifest response. examples: - no-store type: string '401': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unauthorized '403': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Forbidden '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Internal Server Error components: schemas: StreamingManifestHumaResponse: properties: events: description: Business events Reporter can publish. examples: - - dataContentType: application/json defaultPolicy: direct: direct dlq: on_routable_failure enabled: true outbox: fallback_on_circuit_open eventKey: report.requested eventType: requested key: report.requested resourceType: report schemaVersion: 1.0.0 systemEvent: false items: $ref: '#/components/schemas/StreamingEventHumaResponse' type: - array - 'null' publisher: $ref: '#/components/schemas/StreamingPublisherHumaResponse' description: Metadata identifying the Reporter event publisher. examples: - outboxSupported: true routePath: /v1/streaming/events serviceName: reporter source: reporter routes: description: >- Sanitized delivery routes when topology publication is enabled; Reporter omits this field. examples: - [] items: $ref: '#/components/schemas/StreamingRouteHumaResponse' type: - array - 'null' version: description: Semantic version of the manifest wire format. examples: - 1.0.0 type: string type: object Detail: properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details examples: - - location: body.templateId message: expected string to match 'uuid' format value: not-a-uuid items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. type: object StreamingEventHumaResponse: properties: class: description: >- Which of the application's two streams the event rides, and therefore what a consumer with no handler for it does: "fact" is ignored, "command" is quarantined. Always present. Reporter emits only facts. examples: - fact type: string dataContentType: description: Media type of the event data payload. examples: - application/json type: string dataSchema: description: Optional URI identifying the event data schema. examples: - https://schemas.lerian.studio/reporter/report-requested.json type: string defaultPolicy: $ref: '#/components/schemas/StreamingDeliveryPolicyHumaResponse' description: Default delivery policy for this event. examples: - direct: direct dlq: on_routable_failure enabled: true outbox: fallback_on_circuit_open description: description: Human-readable purpose of the event. examples: - A report generation request was accepted. type: string eventKey: description: >- The "." dispatch selector a consumer registers a handler under. Not unique across the manifest: two definitions may share it and differ only in schemaVersion major, so branch on schemaVersion. examples: - report.requested type: string eventType: description: Past-tense business action represented by the event. examples: - requested type: string key: description: Stable catalog key for the event definition. examples: - report.requested type: string resourceType: description: Business resource represented by the event. examples: - report type: string schemaVersion: description: Version of the event payload schema. examples: - 1.0.0 type: string systemEvent: description: >- Whether the event represents system activity instead of a client-triggered business action. examples: - false type: boolean type: object StreamingPublisherHumaResponse: properties: appVersion: description: Reporter application version. examples: - 4.0.0 type: string libVersion: description: lib-streaming manifest version used by Reporter. examples: - 1.0.0 type: string outboxSupported: description: Whether the publisher supports transactional outbox delivery. examples: - true type: boolean producerId: description: Opaque process identifier when a live producer supplies one. examples: - reporter-7f5d9c type: string routePath: description: Authenticated HTTP path serving this manifest. examples: - /v1/streaming/events type: string serviceName: description: Name of the service publishing the events. examples: - reporter type: string source: description: >- The producing application's CloudEvents ce-source: a single dot-free lowercase segment. examples: - reporter type: string type: object StreamingRouteHumaResponse: properties: definitionKey: description: Event definition key served by the route. examples: - report.requested type: string destination: description: Sanitized transport destination. examples: - reporter.events type: string dlqConfigured: description: Whether the route has a dead-letter destination. examples: - true type: boolean key: description: Stable route key. examples: - reports-rabbitmq type: string required: description: Whether route failure makes the logical emit fail. examples: - true type: boolean target: description: Logical delivery target name. examples: - primary type: string transport: description: Outbound transport family. enum: - kafka - sqs - rabbitmq - eventbridge - custom examples: - rabbitmq type: string type: object ErrorDetail: properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' examples: - body.templateId type: string message: description: Error message text examples: - expected string to match 'uuid' format type: string value: description: The value at the given location examples: - not-a-uuid type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object StreamingDeliveryPolicyHumaResponse: properties: direct: description: Direct publication mode. enum: - direct - skip examples: - direct type: string dlq: description: Dead-letter handling mode. enum: - never - on_routable_failure examples: - on_routable_failure type: string enabled: description: Whether delivery is enabled for the event. examples: - true type: boolean outbox: description: Transactional outbox publication mode. enum: - never - fallback_on_circuit_open - always examples: - fallback_on_circuit_open type: string type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.