Reports on API: Difference between revisions
From Planfix
(Created page with "In Planfix, you can create a scheduled report and get its data through the REST API. == Getting data from a scheduled report through the REST API == *Create a recurring report. *Create an authorization token for the employee you plan to send the report to. The saved report data will only be available to the employees you chose to send it to. To create a token, go to '''Account Management''' — '''Access to API''' — '''REST API''' — '''Creat...") |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 5: | Line 5: | ||
*Create an authorization token for the employee you plan to send the report to. The saved report data will only be available to the employees you chose to send it to. To create a token, go to '''Account Management''' — '''Access to API''' — '''REST API''' — '''Create a new token''': | *Create an authorization token for the employee you plan to send the report to. The saved report data will only be available to the employees you chose to send it to. To create a token, go to '''Account Management''' — '''Access to API''' — '''REST API''' — '''Create a new token''': | ||
https://s.pfx.so/pf/ | https://s.pfx.so/pf/tG/P9H4r3.jpg | ||
In the field, select the employee who will receive the scheduled report. | In the field, select the employee who will receive the scheduled report. | ||
| Line 11: | Line 11: | ||
*Get the list of reports through the REST API using the '''/report/list''' method and find the ID of the required report in the response (you can find the report ID in the browser address bar): | *Get the list of reports through the REST API using the '''/report/list''' method and find the ID of the required report in the response (you can find the report ID in the browser address bar): | ||
https://s.pfx.so/pf/ | https://s.pfx.so/pf/Tq/kkKYLP.jpg | ||
*Get the list of saved versions of the selected report using the '''/report/{id}/save/list''' method: | *Get the list of saved versions of the selected report using the '''/report/{id}/save/list''' method: | ||
https://s.pfx.so/pf/ | https://s.pfx.so/pf/nZ/nUPLgK.jpg | ||
*Get the report data by the ID of the new version using the '''/report/{id}/save/{saveId}/data''' method: | *Get the report data by the ID of the new version using the '''/report/{id}/save/{saveId}/data''' method: | ||
Latest revision as of 10:26, 16 February 2024
In Planfix, you can create a scheduled report and get its data through the REST API.
Getting data from a scheduled report through the REST API
- Create a recurring report.
- Create an authorization token for the employee you plan to send the report to. The saved report data will only be available to the employees you chose to send it to. To create a token, go to Account Management — Access to API — REST API — Create a new token:
In the field, select the employee who will receive the scheduled report.
- Get the list of reports through the REST API using the /report/list method and find the ID of the required report in the response (you can find the report ID in the browser address bar):
- Get the list of saved versions of the selected report using the /report/{id}/save/list method:
- Get the report data by the ID of the new version using the /report/{id}/save/{saveId}/data method:
Important
- Saved report data is only available to the employees you select to send it to.
- If the report is large, the version will have several parts (chunks). When getting report data, you must pass the chunk index to get all chunks.
Using the /report/[id]/save/list method, you can determine the number of chunks in the report.