About the SpotMe/Onomi Analytics API
The SpotMe/Onomi Analytics API is a powerful, REST-based suite of endpoints designed to provide comprehensive reporting and engagement data across multiple events, supporting both organizational and cross-organizational levels. As part of the SpotMe/Onomi Data Platform suite, it enables organizations to:
- Aggregate event data and attendee-level insights for detailed analysis and reporting.
- Integrate seamlessly with popular data visualization tools like PowerBI, Tableau, etc.
- Replicate large datasets to external databases, data warehouses, or data lakes.
Key benefits
Powerful analytics: Extract and analyze data in your data warehouse using business intelligence tools like PowerBI, Tableau, or Qlik to uncover actionable insights and drive decisions.
Seamless integration: Consolidate data from SpotMe/Onomi and other systems in one centralized location for comprehensive analysis and reporting.
AI-ready: Leverage the rise of artificial intelligence and large language models (LLMs)by using SpotMe data to train custom models tailored to your organization’s needs.
Preservation of historical data: Ensure historical data remains accessible over time regardless of the lifecycle of individual event workspaces, enabling long-term analysis and reporting.
Scalable and secure: Benefit from a high-performance, REST-based API architecture secured by bearer token authentication, ensuring robust and reliable data access.
Solution capabilities
The Analytics API is a suite of endpoints designed to provide structured access to organizational data. These endpoints are organized into the following scopes:
- Organization level: Provides access to data for a single organization, allowing detailed analysis and reporting specific to that entity.
- Multi/cross-organization level: Offers access to data across multiple organizations within a customer’s account. This is ideal for cases where an organization operates in multiple countries, sectors, or divisions, enabling cross-organization analysis and benchmarking.
Actionable insights: Gain comprehensive access to event-level and cross-organizational data to unlock valuable insights that drive informed decision-making. With the Analytics API, organizations can analyze detailed metrics such as attendee engagement, session performance, and content interaction across multiple events.
Developer-friendly: Simplify integration and development with robust resources designed to support your technical needs. The Analytics API offers detailed API documentation, integration guides for popular tools such as PowerBI, Tableau, and data lakes, as well as OpenAPI specifications compatible with platforms like Postman.These resources enable developers to quickly adopt the API, streamline workflows, and build powerful data solutions.
Secure and scalable architecture: Built on a reliable and scalable REST-based framework, the Analytics API ensures seamless integration into your existing systems. With bearer token authentication, it provides robust security and controlled access to protect your data while maintaining optimal performance for high-volume use cases.
Effortless connectivity: Easily integrate the Analytics API with leading data warehouses such as Snowflake, BigQuery, and AmazonRedshift. Streamline data transfer and analysis workflows by leveraging built-in compatibility with modern data platforms. (Supported formats: parquet, csv).
Typical use cases
Monitoring trends over time, such as audience preferences, engagement rates, participant engagement scores, and peak activity periods, to optimize the planning and execution of future events.
Perform cross-organizational analysis to compare and benchmark performance metrics across multiple entities, uncovering deeper operational insights.
Create custom dashboards in tools like PowerBI or Tableau, giving stakeholders real-time visibility into key performance indicators.
Leverage historical data for predictive analytics, enabling you to forecast trends, identify areas for improvement, and proactively address potential challenges.
Basic information
-
The SpotMe Analytics API is the main component of the SpotMe Data Platform.
It is a file-based API suite supporting CSV and Parquet formats, engineered to deliver rich, multi-event reporting and engagement insights. -
The SpotMe Analytics API base URL is https://api.spotme.com/api/v2/
-
For a general list of available API endpoints, please check https://developer.spotme.com/docs/analytics
How to access the SpotMe Analytics API
To access and use the SpotMe Analytics API, please contact your SpotMe Account Manager.
Analytics API data model diagrams and use cases
From workspace and organization data to SpotMe API Analytics
The below diagram shows how the event data at the workspace and organization level (SpotMe REST API) is aggregated and processed via the SpotMe Analytics API in order to produce event data that can be consumed by a customer data warehouse or data lake.
Open diagram in full screen:
Integrating data from SpotMe API Analytics
Scenario 1: Data visualization (SpotMe event data only)
Example: Provide event data visualization (dashboards) for a detailed view of aggregated event performance/ROI metrics:
Open diagram in full screen:
Scenario 2: Data visualization + 360 omnichannel view (SpotMe event data aggregated with other data sources)
Example: Provide event data visualization (dashboards) and reconciliation with attendee/HCP profiles, for a 360 view of all touch points/engagements/performance metrics:
Open diagram in full screen:
Scenario 3: Data visualization + 360 omnichannel view (SpotMe event data aggregated with other data sources) + omnichannel orchestrations
Example: Event data visualization (dashboard) and reconciliation with attendee/HCP profiles, for a 360° view of all touch points/engagements/performance metrics and orchestration of marketing automation and next-best-action based on that data:
Open diagram in full screen:
How to access a full list of data attributes via the API Analytics documentation section
To see all attributes for each data entity in the SpotMe Analytics API:
- Go to https://developer.spotme.com/docs/analytics, where you will see a full list of the default data entities.
- Select the GET request for a data entity, for example "Document download":
- Scroll down to the Responses section for the data entity, and click on More details:
- A full list of the attributes displayed to the left in the "Property" column:
You can also click on the Example value tab to access a code example for the data attributes:
Rate limits
- The API access is currently rate-limited to no more than 3 requests per seconds, with bursts not exceeding 5 requests per second maximum for a given API user (i.e. for a given authorization header).
- If this rate is exceeded, the caller will receive a "429" error code and will need to retry later.
- There is a hard limit at max. 5,000 documents in one call, as well as a maximum payload of 5 MB.
Note: Limits are applied to the API calls, but there are no limits applied to the size of the documents to be downloaded (CSV and Parquet formats that allow for large file transfers).
Want to find out more?
Should you have any questions or wish to use SpotMe API Analytics, please reach out to your SpotMe Account Manager.
Comments
0 comments
Please sign in to leave a comment.