Skip to content
Developers Docs

Release Notes

Release 4.7

Release Date: 2022-05-01
Last Updated: 2024-11-12

New API Introduction: api/analytics/Positioning/AnalyticsSummaries

We are excited to announce the release of a new API: api/analytics/Positioning/AnalyticsSummaries. This API is designed to streamline your data retrieval process and provide more comprehensive analytics summaries.

Features:
  • PosAnalyticsRequest: The new API accepts a PosAnalyticsRequest object which includes several optional fields for filtering:
  • PropertyIds
  • BuildingIds
  • UserIds
  • Emails
  • SessionIds
  • SessionIndices
  • IncludeTrajectories: A crucial field that indicates whether to include trajectory data in the result.
  • includeVisitZoneGeofences: A crucial field that indicates whether to include zone geofence data in the result.

  • PosAnalyticsResponse: The API returns a PosAnalyticsResponse object containing detailed analytics information, including user info, property info, session info, trajectory info, transitions, and visit zone geofences.

API Deprecation Notice

With the introduction of api/analytics/Positioning/AnalyticsSummaries, several existing APIs are now marked for deprecation. These APIs can now be replaced by the new, more efficient API:

  • api/analytics/Positioning/UserSummaries (for a single user visiting multiple properties)
  • api/analytics/Positioning/PropertySummaries (for a single property visited by many users)
  • api/analytics/Positioning/UserTrajectoriesSummaries (User Trajectory info)
  • api/analytics/Positioning/UserTrajectoriesSummariesV2 (User Trajectory info, requiring both userUID and email)

Transition Period

You may continue to use these deprecated APIs until the next major version update. However, we encourage you to start integrating with the new api/analytics/Positioning/AnalyticsSummaries API to take advantage of its enhanced capabilities and to future-proof your application.

Internal Routing and Compatibility

Internally, we are routing requests to the new logic under the api/analytics/Positioning/AnalyticsSummaries API. This ensures that data is organized and returned in the old structures if you call the deprecated APIs, maintaining compatibility during your transition period.

We appreciate your cooperation and understanding as we work to improve our API offerings. Please don't hesitate to reach out to our support team if you have any questions or need assistance with the transition.


Release Date: 2022-05-01
Last Updated: 2024-04-25

  • Included UserTrajectoriesInfo API to efficiently load trajectories information and Trajectory API to get individual trajectory data.
  • Included APIs to create/modify/archive ZoneGeofences.
  • Included Boosts analytics APIs.
  • Included BTags analytics APIs.

For more information, please see the 4.7 API references.

Release 4.6

Release Date: 2021-12-20

  • Included explicit stationary points in user trajectories.

For more information, please see the 4.6 API references or the 4.6 migration guide.