The Reports API provides access to the details of your company reports.
Required permissions
The service user that you use for endpoint that access report should have the following permissions:
- Features > Reports > View reports according to people's data access rights.
When retrieving reports that have formulas in them, you need to add an additional permissions:
- Features > Formulas in Grids > View formulas in grids.
- If the formula includes fields, you should allow the relevant field's category.
To learn more about permissions, see Setting permissions to Service Users .
Rate limiting
Below is a table detailing the rate limits for each endpoint in the Onboarding endpoints.
Method | Endpoint | Limit per minute |
---|---|---|
GET | Read company reports | 20 |
GET | Download the report by ID | 20 |
GET | Get the report download URL for polling | 20 |
GET | Download report by file URL | 20 |