APIs for accessing commercial marketplace analytics data

Following are the list of APIs for accessing commercial marketplace analytics data and their associated functionalities.

Dataset pull APIs

Table 1: Dataset pull APIs

API Functionality
Get all datasets Gets all the available datasets. Datasets list the tables, columns, metrics, and time ranges.

Query management APIs

Table 2: Query management APIs

API Functionality
Create Report Query Creates custom queries that define the dataset from which columns and metrics need to be exported.
GET Report Queries Gets all the queries available for use in reports. Gets all the system and user-defined queries by default.
DELETE Report Queries Deletes user-defined queries.

Report management APIs

Table 3: Report management APIs

API Functionality
Create Report Schedules a query to be executed at regular intervals.
TRY Report Queries Executes a Report query statement. Returns only 10 records that a partner can use to verify if the data is as expected.
Get Report Get all the reports that have been scheduled.
Update Report Modify a report parameter.
Delete Report Deletes all the report and report execution records.
Pause Report Executions Pauses the scheduled execution of reports.
Resume Report Executions Resumes the scheduled execution of a paused report.

Report execution pull APIs

Table 4: Report execution pull APIs

API Functionality
Get Report Executions Get all the executions that have happened for a given report.

Next steps