Using Onomi APIs, event streaming, analytics, and BI

Choose the integration surface from the job it must perform. Operational REST APIs read or change workspace-backed event data, event streaming publishes agreed lifecycle events, and the Analytics API supplies analysis-ready files for reporting.

Do not treat the surfaces as interchangeable. Their access models, data populations, and delivery guarantees differ.

Use the operational REST API

Use the REST API for a customer portal, an internal tool, a scheduled synchronization job, or another system that needs workspace records. The API uses JSON over HTTPS and organizes endpoints by organization, workspace, and module.

Workspace endpoints cover records such as people, speakers, sessions, session registrations, documents, and sponsor content. A POST carrying an existing identifier acts as an upsert where the endpoint documents that behavior, allowing a retry to update instead of duplicate.

Start with Getting started with the REST API and the REST API overview.

Use a dedicated integration account

An organization administrator enables Developer API access for an eligible Backstage user. Create the bearer token from that user's API tokens tab and store it in a secret manager when it is shown.

The token inherits the reach of its owner. Use a dedicated account per connected system, review its organization role and workspace membership, and revoke its token when the connection is retired.

Follow the rate and payload limits in the current API reference. Build batching, backoff for HTTP 429 responses, idempotent retries, and reconciliation into the client instead of sending one request per record.

Understand the workspace boundary

The operational REST read endpoints and the Analytics API address events backed by an event workspace. A record-only meeting has no workspace, so those endpoints do not expose its full strategic meetings management record.

Read each record-only component from the surface that owns it:

• request and approval history from Event requests and its export;
• costs from Onomi 360 reports and the report builder;
• confirmed allocation from the event's Transfer of value module;
• meeting and attendee records through the configured CRM synchronization; and
• attendance from the event record, Contacts, or the configured CRM flow.

Inbound ERP costs and invoices can still address the Onomi event record because that integration does not depend on a workspace API. Whether a request category creates a workspace is configured under Policies > Event creation.

Publish lifecycle events to streaming middleware

Use event streaming when a connected system must react to lifecycle changes without polling. Agree the event names, versioned payloads, identifiers, ordering expectations, retry behavior, and dead-letter process with your SpotMe implementation team.

Native publication addresses the workspace-backed events named in that contract. A consumer should treat delivery as at least once unless the customer-specific contract states otherwise, using the event identifier and event version to make processing idempotent.

Keep business transformation in your middleware. It can route the same validated event to a CRM, warehouse, notification service, or customer-specific workflow without coupling Onomi to each destination.

Use the Analytics API for enterprise reporting

The Analytics API is a reporting surface separate from the operational API. It supplies documented entities as CSV or Parquet so a warehouse or BI tool can load them without paging through operational records.

Your SpotMe Account Manager enables Analytics API access and the required organization- or customer-scope role. Keep this permission separate from Developer API access and create credentials for a dedicated data integration account.

The reference at developer.spotme.com/docs/analytics lists the entities, attributes, formats, and OpenAPI definition.

Organization scope serves reporting within one organization. Customer scope supports reporting across the customer's organizations when that access has been enabled.

Archived workspaces remain available only as described by the current Analytics API and retention documentation. Load any history that must outlive the source workspace before its retention period ends; see How are workspaces archived or deleted?.

Coverage boundaries

Test workspaces can appear in the events entity without detailed data points or aggregate counts. Keep test activity out of production models through the agreed environment and workspace filters.

The record-only boundary also applies to the Analytics API, scheduled extracts, and live feeds that use its data model. Onomi 360 operational reports cover strategic meetings management records that this API does not expose.

Connect a warehouse or BI tool

Load each required entity into a staging layer, preserve the Onomi identifiers, and model the joins in the customer's warehouse. Tools such as Power BI, Tableau, Qlik, Snowflake, BigQuery, and Amazon Redshift can consume the documented CSV or Parquet output.

The Analytics API overview describes the surface. The single-source Power BI guide shows the query, authentication, typing, and date conversion for one source.

Verify the first connection by pulling the events entity and checking identifiers, dates, scope, and expected counts. Then add other entities one at a time and reconcile them against the corresponding Onomi view.

Choose scheduled exports or live feeds

Use scheduled exports for recurring files that a business team or batch process consumes. Use live feeds when a downstream dashboard or process needs changes closer to real time.

For either route, document the schedule or latency expectation, file or message format, delivery destination, credential owner, retry behavior, and reconciliation check. The customer BI team owns downstream models and joins; SpotMe owns the published schema and the enabled delivery surface.

For operational reports and their scheduler, see How to use Onomi 360: the portfolio calendar, engagement view, and reports. For the other integration families, see Integration patterns: connecting Onomi to your enterprise systems.

* Onomi 360 MeetingsEQ exclusive capabilities.