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 the endpoint guides and links here: https://flowsite.com/docs/dashpivot/api/ouhv7wr0gxswy-how-to-connect-to-sitemate-open-api
App summary Endpoint:
The app summary endpoint will allow you to list a summary of all template apps within a specified folder. It can be accessed here: https://flowsite.com/docs/dashpivot/api/q9i2bubcntyuz-list-app-summaries-in-folder
Quick walkthrough of the form summary and app summary endpoints:
Deploy a template from the template library to specified folders: https://flowsite.com/docs/dashpivot/api/v8yl0w6v9w0bz-deploy-template-to-folders
Undeploy a template from specified folders: https://flowsite.com/docs/dashpivot/api/12417d70ab0ab-undeploy-template-from-folders
Exports Endpoints:
The exports endpoints will allow you to export a list of forms, as PDF or CSV, from Dashpivot. They be accessed here:
Export forms as PDF: https://flowsite.com/docs/dashpivot/api/gqew17cwxd9ff-export-forms-as-pdf
Export forms as CSV: https://flowsite.com/docs/dashpivot/api/9qlys2chhzl5t-export-forms-as-csv
Get export status: https://flowsite.com/docs/dashpivot/api/ruhq7jo76fjrr-get-export-status
Folder summary Endpoint:
List all folders in the root directory. In practice, this endpoint will list all the workspaces you have access to: https://flowsite.com/docs/dashpivot/api/6ec93b2248525-get-a-list-of-root-folders
Get a specific folder: https://flowsite.com/docs/dashpivot/api/12f8f34aef00f-get-folder-by-id
Update a specific folder: https://flowsite.com/docs/dashpivot/api/e72752939367a-update-folder
Delete a specific folder: https://flowsite.com/docs/dashpivot/api/b1dbc480c9dda-delete-folder
List the child folders for a specified folder. This endpoint can be used to navigate through nested folders: https://flowsite.com/docs/dashpivot/api/eeacf3ae976ad-list-folder-children
Create a new child folder within the specified folder. The specified folder will be the parent of the new child folder: https://flowsite.com/docs/dashpivot/api/14837a5e2c68e-create-child-folder
Form summary Endpoint:
The form summary endpoint will allow you to list a summary of all forms for the specified App. It can be accessed here: https://flowsite.com/docs/dashpivot/api/vkzewnj7vjti9-form-summary