Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Following are the list of APIs for partner insights analytics 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 Query | Gets all the queries available for use in reports. Gets all the system and user-defined queries by default. |
DELETE Report Query | 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 Query | 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. |
You can try out the APIs through the Swagger API URL.