New article
Recently updated
PleaseReport Responses & Usage Limits
Who is this article for?Please Review administrators or data scientists.
Access keys for PleaseReport are required.
PleaseReport is accessed through a Data API and Gateway with a URL Endpoint and Access Key. The connection details will provide access to the full array of views available.
Access via the Gateway carries a data access limit of 2Gb that restricts how much data can be returned by each connection per day. This limit is reset every 24 hours. If you wish to know at any point how much of your limit you have used, or how much is remaining, the details can be found in the headers of any calls to the API.
Details on usage of the Gateway is included in the headers of requests returned from the API. While these details can be gleaned from any requests placed through Power BI, Excel, or other end user tools, it is easiest to analyse this data if using a direct connection to the Rest API, via a tool like Postman for example. A simple request to the gateway will return a full set of headers and the contents will tell you the status of your gateway.
This article provides details on:
1. Response Codes
The Data API uses standard HTTP response codes to indicate success or failure.
|
HTTP response code |
Indicating |
Notes |
|---|---|---|
|
200 |
Success |
Response body contains the requested oData structures |
|
401 |
Unauthorized |
The required key X- IdeagenDataAPIKey was not found in the request or is not valid. |
|
404 |
Not found |
The endpoint you attempted to access does not exist |
|
429 |
Limit exceeded |
See below |
|
500 (or greater) |
An error occurred in the Data API. |
No more information is available. Contact Ideagen support |
2. Response Headers
For 200 and 429 class response codes the Data API will return the following additional headers.
Note: This information is in the header of the response and not in the response body.
|
Header |
Example value |
Notes |
|---|---|---|
|
X-Download-Limit-Limit |
1750000000 |
The total number of bytes you may download |
|
X-Download-Limit-Remaining |
1750000000 |
The number of bytes you’ve downloaded so far. If this reaches 0, a 429 response code will be returned. Requests should not be retried until the time in X-Download-Limit-Reset has passed. |
|
X-Download-Limit-Reset |
2020-10-06T11:40:00.2244680Z |
The number of bytes you’ve downloaded so far. If this reaches 0, a 429 response code will be returned. Requests should not be retried until the time in X-Download-Limit-Reset has passed. |
|
X-Upload-Limit-Limit |
1750000000 |
The total number of bytes you may uploaded |
|
X-Upload-Limit-Remaining |
1750000000 |
The number of bytes you’ve downloaded so far. If this reaches 0, a 429 response code will be returned. Requests should not be retried until the time in X-Upload-Limit-Reset has passed. |
|
X-Upload-Limit-Reset |
2020-10-06T11:40:00.1149019Z |
The number of bytes you’ve downloaded so far. If this reaches 0, a 429 response code will be returned. Requests should not be retried until the time in X-Upload-Limit-Reset has passed. |
|
X-Rate-Limit-Limit |
1000 |
The total number of requests you may make per minute |
|
X-Rate-Limit-Remaining |
999 |
The number of requests so far. If this reaches 0, a 429 response code will be returned. Requests should not be retried until the time in X-RateLimit-Reset has passed. |
|
X-Rate-Limit-Reset |
2020-10-06T11:40:00.1134432Z |
The number of requests so far. If this reaches 0, a 429 response code will be returned. Requests should not be retried until the time in X-RateLimit-Reset has passed. |