Get started with programmatic access to analytics data for commercial marketplace

  • Article

This guide helps you get on-boarded to programmatic access to Commercial Marketplace Analytics data. You'll learn how to programmatically access analytic reports to monitor sales, evaluate performance, and optimize offers in the commercial marketplace. The improved analytics tools enable you to act on performance results and maintain better relationships with your customers and resellers.

Important

Version 1.1 of APIs are now live. Please migrate the existing implementation to the latest version

About this guide

You can use this guide to programmatically access commercial marketplace analytics data. By using the methods and APIs documented in this guide, you can schedule custom reports and ingest key data sets into your internal analytics systems. You can effectively monitor sales, evaluate performance, and optimize your offers in the commercial marketplace.

The API for accessing commercial marketplace reports enables you to schedule custom reports of your analytics data asynchronously. The capability enables you to define reporting queries/templates based on your needs, set a schedule, and get timely and trustworthy reports at scheduled intervals.

The key value of programmatic access of commercial marketplace analytics data is customized reporting and integration with internal BI systems and platforms.

Note

Partners need dedicated engineering resources to do one time onboarding on the API interface.

Change log of Version 1.1

  • Recurrence count: The recurrence count parameter is now mandatory. This means that all scheduled reports must have a recurrence count.

  • Execution GET API: The 1.1 version of the GET Execution API will return additional information about the recurrence count (remaining), end date, and next execution start time.

  • Scheduled Report PUT API: The 1.1 version of the API will allow users to update the end date of their scheduled reports in addition to the recurrence count.

  • Recurrence count limits are based on the Recurrence Interval of the scheduled reports.

Warning

Version 1.0 of the API will be deprecated in 6 months ending 30 June 2024. This means that we will no longer provide support or updates for this version after this date. Please plan the migration accordingly.

 Migration instructions from v1 to v1.1: To migrate to version 1.1 of the API, please follow these steps:

  • Update your code to use the new endpoint for version 1.1 of the API.

  • Update any requests or responses that reference fields that have been added or changed in version 1.1.

  • Test your code thoroughly to ensure that it is compatible with version 1.1 of the API.

  • Monitor your application to ensure that it is functioning correctly with the new version of the API.

Next steps