> ## Documentation Index > Fetch the complete documentation index at: https://developer.easyparkgroup.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve report generation status > Returns the current report generation status. For in-progress reports, includes retry information with recommended wait time. For completed reports, automatically redirects to the download link for the generated report. In case of a report generation error, provides error details. ## OpenAPI ````yaml get /report/generate/{reportIdentifier} openapi: 3.1.0 info: title: Operator Financial Reporting API description: > Operator Financial Reporting API is a collection of endpoints (currently available only in US region) that allows parking operators and data aggregators to fetch parking transactions report which will be generated in JSON or CSV formats. ## API Usage Workflow 1. Authenticate using the `auth/v1` endpoint to obtain a JWT token 2. Use the token in subsequent requests in the X-Authorization header 3. Generate a report using the `/report/generate` endpoint 4. Check report status using the URL returned in the response 5. Since reports take time to generate, the API follows a polling approach where users request a report, then periodically check its status until completion. 6. Download the completed report when status indicates it's ready ## Authentication of API user API users must authenticate using JWT tokens passed in the `X-Authorization` header with the format `Bearer YOUR-JWT-TOKEN`. Tokens can be obtained from the `auth/v1` endpoint using client credentials (clientId and clientSecret). For testing purposes, you can request test credentials from the support team. ## Error Handling The API returns appropriate HTTP status codes and detailed error messages: * 400: Bad Request - Invalid parameters or request structure * 401: Unauthorized - Missing or invalid authentication token * 403: Forbidden - Insufficient permissions for the requested operation * 429: Too Many Requests - Rate limit exceeded * 500: Internal Server Error - Something went wrong on the server side **Important Note**: When checking report status, if the report generation fails, the API returns a 200 OK HTTP status code with a problem details object in the response body containing status code 400. Client applications should always check the response content type (application/problem+json) and examine the response body to properly handle error scenarios. ## Testing in Staging Environment * URL: https://operator-financial-reporting.staging.ezprk.dev * Database: Contains sample parking transactions for testing purposes * Test Operator ID: 60879 (use this ID for testing report generation) * Data Range: Test data is available for last two days, each day having 5 records * Authentication: Use test credentials provided by the support team * Rate Limits: 30 requests per 10 min in test environment ## Report Formats and Limitations * Available formats: JSON or CSV * Maximum report size: 100,000 records * Historical data available: Up to 3 months from current date * Default columns: Always included in the report * Additional fields: Can be requested as needed The report contains default columns and additional fields requested by the user. ## Response Format and Pagination * All successful responses use HAL+JSON format with hypermedia links * Long-running operations follow the HATEOAS pattern with self-referencing links * Reports follow an asynchronous generation pattern with status polling ## Environment URLs * Production US: https://operator-financial-reporting.usa.ezprk.net * Staging: https://operator-financial-reporting.staging.ezprk.dev version: 2025.0.0 servers: - url: https://operator-financial-reporting.staging.ezprk.dev description: Staging - url: https://operator-financial-reporting.usa.ezprk.net description: Production US security: [] tags: - name: Report Resource description: API for generating and downloading reports - name: Authentication Resource description: API for authentication paths: /report/generate/{reportIdentifier}: get: tags: - Report Resource summary: Retrieve report generation status description: > Returns the current report generation status. For in-progress reports, includes retry information with recommended wait time. For completed reports, automatically redirects to the download link for the generated report. In case of a report generation error, provides error details. operationId: getReportStatus parameters: - name: reportIdentifier in: path description: The report identifier from the report generation initiation response required: true schema: type: string responses: '200': description: > Provides the current status of report generation. Includes self-reference links for in-progress report or error details for failed report. content: application/hal+json: examples: In Progress Status Response: summary: Example response when report generation is in progress description: In Progress Status Response value: message: >- Your report is being generated. Check for the report status after 30 seconds. retryAfter: 30 _links: self: href: >- https://operator-financial-reporting.staging.ezprk.dev/report/generate/{reportIdentifier} application/problem+json: examples: Failure Status Response: summary: Example response when report generation encounters a failure description: Failure Status Response value: title: Maximum number of 100,000 records exceeded. detail: Maximum number of 100,000 records exceeded. status: 400 '303': description: >- Report generation completed successfully; redirects to download location headers: Content-Location: description: URL of the status endpoint style: simple schema: example: /report/generate/{reportIdentifier} Content-Type: description: HAL+JSON content type style: simple schema: example: application/hal+json Location: description: URL to download the report style: simple schema: example: /report/{reportIdentifier} content: application/hal+json: examples: Report Completed Status Response: summary: Example response when report generation is complete description: Report Completed Status Response value: message: Your report is ready _links: self: href: >- https://operator-financial-reporting.staging.ezprk.dev/report/generate/{reportIdentifier} report: href: >- https://operator-financial-reporting.staging.ezprk.dev/report/{reportIdentifier} security: - jwt: [] components: securitySchemes: jwt: type: apiKey description: >- For the header value, use the format: `Bearer YOUR-JWT-TOKEN`. You can get the token from the auth/v1 endpoint. name: X-Authorization in: header ````