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 | This API shall be called to get list of available datasets and respective columns, metrics, and time ranges. |
Query management APIs
Table 2: Query management APIs
| API | Functionality |
|---|---|
| Create Report Query | This API shall be used to create query as per the use case. |
| GET Report Queries | This API shall be used to get the list of queries. |
| DELETE Report Queries | This API shall be used to delete any user defined query. |
| TRY Report Queries | This API shall be used to test the query and validate the data. |
Report management APIs
Table 3: Report management APIs
| API | Functionality |
|---|---|
| Create Report | This API shall be used to create or schedule a report based on query ID. |
| Get Report | This API shall be used to get the list of created reports. |
| Update Report | This API shall be used to modify a report parameter. |
| Delete Report | This API shall be used to delete any report and respective execution records. |
| Pause Report Executions | This API shall be used to pause the scheduled execution of reports. |
| Resume Report Executions | This API shall be used to resume the scheduled execution of a paused report. |
Report execution pull APIs
Table 4: Report execution pull APIs
| API | Functionality |
|---|---|
| Get Report Executions | This API shall be used to get all the executions for a report. |
You can try out the APIs through the Swagger API URL.