API endpoints are the specific web addresses where an application can send or receive data from another system. They serve as connection points that allow different software to communicate and exchange information in a structured way.
In the Sitemate Open API, an endpoint could be used to retrieve a list of forms, while another might allow users to create new project folders. Each endpoint has a specific function, ensuring seamless data transfer between Dashpivot and other tools like reporting dashboards or project management systems.
You can access all the endpoint guides and links here: https://flowsite.com/docs/dashpivot/api/ouhv7wr0gxswy-how-to-connect-to-sitemate-open-api
App endpoints:
Action | Documentation Link |
App Summary endpoint
The app summary endpoint will allow you to list a summary of all template apps within a specified folder | |
Deploy an app from the app library to specified folders | |
Undeploy an app from specified folders |
Quick walkthrough of the form summary and app summary endpoints:
Exports Endpoints:
The exports endpoints will allow you to export a list of forms, as PDF or CSV, from Dashpivot
Action | Documentation Link |
Export forms as PDF | |
Export forms as CSV | |
Get export status |
Quick walkthrough of the export endpoints:
Folder Endpoints:
Action | Documentation Link |
List all folders in the root directory
In practice, this endpoint will list all the workspaces you have access to | |
Get a specific folder | |
Update a specific folder | |
Delete a specific folder | |
List the child folders for a specified folder
This endpoint can be used to navigate through nested folders | |
Create a new child folder within the specified folder
The specified folder will be the parent of the new child folder |
Form Endpoints:
Action | Documentation Link |
List form summaries for app
List a summary of all forms for the specified App |