Reports on API

Planfix offers two ways to retrieve report data via the REST API:

• You can create a scheduled report and retrieve its data through the REST API.
• Trigger the report generation via the REST API and retrieve the data as soon as it is ready.

You can find the full REST API specification here.

Retrieving data from a scheduled report via 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 Employee / Contact field, specify the employee who will receive the scheduled report.
  • In the Allowed Scopes field, enter: report_readonly.

• Retrieve 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).

• Retrieve the list of saved versions of the selected report using the /report/{id}/save/list method.

• Retrieve the report data by the ID of the new version using the /report/{id}/save/{saveId}/data method.

Data retrieval considerations

• 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.

Generating reports via REST API

• 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 Employee / Contact field, specify the employee who will receive the scheduled report.
  • In the Allowed Scopes field, enter: report_readonly.

• Trigger report generation using the /report/{id}/generate endpoint. The response will return a requestId.

• After a short delay, check the report's status using /report/status/{requestId}.

The response will include a ReportSave object (same format as scheduled reports) if the report is ready.

• Retrive the report data by the ID of the saved version using the /report/{id}/save/{saveId}/data method.

Generation limitations

• Available only on the Corporate pricing plan.
• Reports can be generated at most once every 10 minutes.
• Only one report can be generated at a time per account.
• Reports are generated on behalf of the user associated with the API token, and their access permissions apply.

Go To

• Scheduled Report
• Reports
• Feature Description