> ## Documentation Index > Fetch the complete documentation index at: https://docs.ctrl-hub.com/llms.txt > Use this file to discover all available pages before exploring further. # Get a report run > Retrieve a specific report run by its unique identifier. ## OpenAPI ````yaml /api-reference/openapi.yaml get /v3/report-runs/{report_run_id} openapi: 3.1.0 info: contact: email: support@ctrl-hub.com name: Ctrl Hub url: https://www.ctrl-hub.com description: > Ctrl Hub is the all-in-one platform for high-risk industries like utilities, construction, infrastructure, and renewables. We help teams manage everything from risk assessments and HAVS exposure to vehicle and equipment checks, with a guaranteed minimum of 200% ROI. license: name: MIT License url: https://opensource.org/licenses/MIT summary: An API for managing your compliance and risk posture termsOfService: https://www.ctrl-hub.com/terms-conditions title: Ctrl Hub version: 1.0.0 servers: - description: Production url: https://api.ctrl-hub.com - description: Staging url: https://api.ctrl-hub.dev - description: Development url: https://api.ctrl-hub.run security: [] tags: - description: | Actions are follow-ups assigned to users and teams, produced manually or by domain producers such as the data-capture workflow runner. name: Actions - description: | Audit events are the events that are logged by the system. name: Audit Events - description: | View the platform's health and availability. name: Status - description: > User-owned dashboards composed of cards on a fixed-slot bento layout. Cards come from a per-domain registry; the API stores their config as opaque JSON. name: Dashboards - description: > A record of documents the platform generated and handed over, retained as evidence of what was issued. `subject_type` says what kind of records an export covers, and it is what decides how the request is authorised: there is no export permission of its own, so if you can see the records you can export them. name: Exports - description: > Scheduled delivery of a saved query's results, as a CSV attachment or a summary email. Every run is retained with the file it sent, so what a recipient received stays retrievable. A report runs as the person who created it, under their own access. name: Reports - description: | Manage appointments for work to be carried out with your customers name: Customer Appointments - description: | Manage interactions you have with your customers name: Customer Interactions - description: | Manage accounts for your customers name: Customer Accounts and Contacts - description: | Qualifications are the skills and knowledge that an organisation requires. name: Qualifications - description: | Workflows allow you to automate your processes. name: Workflows - description: | Manage documents name: Documents - description: | Manage documents name: Folders - description: | Manage documents name: Document Reviews - description: | Manage feature configurations for an organisation. name: Feature Configurations - description: | Equipment are the physical assets that an organisation manages. name: Equipment - description: | The central cost register: time-versioned rate codes for material, labour, contractor and miscellaneous spend, used to cost work against the job hierarchy. name: Costs - description: > Locations are places an organisation manages, optionally classified by a location type. name: Locations - description: | Manage your forms and their schemas name: Forms, Schemas and Categories - description: | Create and view form submissions name: Submissions - description: | View the roles available in the system. name: IAM Roles - description: > IAM role groups can be assigned to principals to manage authorisation centrally. name: IAM Role Groups - description: | Manage service accounts which can access the API programmatically. name: Service Accounts - description: | Manage bridges between organisations. name: Bridges - description: | Manage settings for an organisation. name: Settings - description: | Manage teams within an organisation. name: Teams - description: | Manage job roles within an organisation. name: Job Roles - description: | Manage users and accounts. name: Users - description: | Invite and manage invitations to organisations. name: Invitations - description: > IAM grants are the asignment of roles or permissions to principals to manage resource access. name: IAM Grants - description: | View the permissions available in the system. name: IAM Permissions - description: | SSO providers are the identity providers for an organisation. name: SSO Providers - description: | Whoami returns information about the currently authenticated principal. name: Whoami - description: | Manage your images name: Images - description: > AI agent personas that synthesise data into role-specific intelligent briefings. name: Agents - description: | Briefings generated by AI agents, including reasoning traces. name: Briefings - description: > Organisations are the center point for most resources in the platform. Most other endpoints are subresources of an organisation. name: Organisations - description: | Permits managements, integrated with street manager. name: Permits - description: | Projects manage your work and governance. name: Projects - description: > Import templates allow users to save and reuse their CSV importer configuration as named templates. name: Import Templates - description: | Properties are the physical locations. name: Properties - description: | Search across schemes, work orders, and operations. name: Search - description: | Provides the API specification in JSON and YAML formats name: Specifications - description: | Streets are the physical roads. name: Streets - description: | Integration with street manager name: Street Manager - description: | Vehicles are the physical vehicles that an organisation manages. name: Vehicles - description: > Scheme contracts (also known as regions) group schemes allocated from the network to a contractor. name: Scheme Contracts - description: > Scheme shares allow you to share your schemes with other organisations across bridges. name: Scheme Shares - description: | Schemes are large programmes of work name: Schemes - description: | Work orders the component parts of a scheme. name: Work Orders - description: | Operations are the work to be carried out within work orders. name: Operations externalDocs: description: More documentation and resources url: https://docs.ctrl-hub.com paths: /v3/report-runs/{report_run_id}: get: tags: - Reports description: Retrieve a specific report run by its unique identifier. operationId: GetReportRun parameters: - $ref: '#/components/parameters/report_run_id' - $ref: '#/components/parameters/report_runs_include' responses: '200': $ref: '#/components/responses/GetReportRun' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorised' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' security: - Session: [] - Cookie: [] - OAuth2: [] components: parameters: report_run_id: name: report_run_id in: path required: true description: The unique identifier for the report run. schema: type: string format: uuid example: c0ffee00-0000-0000-0000-000000000012 report_runs_include: name: include in: query description: A comma separated list of related resources to include. required: false style: form explode: false schema: type: array items: type: string enum: - organisation - report responses: GetReportRun: description: An individual report run. headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: allOf: - type: object required: - data properties: data: $ref: '#/components/schemas/ReportRun' included: $ref: '#/components/schemas/ReportRunIncludes' - $ref: '#/components/schemas/JSONAPI' BadRequest: description: > There was an error with the request - this could be due to an invalid body, query parameters, or headers that were sent to the API. headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 98ca4a78-b66f-4234-9719-aaf832ee6669 status: '400' title: A validation error was encountered source: parameter: include meta: resource: wrong_value Unauthorised: description: Authentication failed headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 05fc9c8d-73b9-4697-9337-57f7a567a48f status: '401' title: You are not authorised to access this resource detail: In order to access this resource, you need the 'admin' role. code: AUTH.001 NotFound: description: The requested resource could not be found headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 7b4c8f12-3e9a-4d5b-8c6f-1a2b3c4d5e6f status: '404' title: Resource not found detail: The requested resource could not be found or does not exist. code: NOT_FOUND.001 InternalServerError: description: There was a problem handling the request on the server side headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: fe9d9a69-f0a7-4fdc-bb2c-176027f316c5 status: '500' title: Internal Server Error detail: An unexpected error occurred on the server. headers: content-type: description: The content type of the response schema: type: string example: application/vnd.api+json content-length: description: The length of the response body in bytes schema: type: integer format: int32 example: 1234 x-request-id: description: >- An ID that can be provided when reporting bugs to help identify the issue schema: type: string example: 8470f56af4cf25e22be08e72c70dbbdc schemas: ReportRun: type: object description: One delivery of a report, kept as the record of what was sent and when required: - id - type - attributes - meta - relationships properties: id: type: string format: uuid description: The unique identifier of the report run. type: type: string const: report-runs attributes: $ref: '#/components/schemas/ReportRunAttributes' meta: $ref: '#/components/schemas/ReportRunMeta' relationships: $ref: '#/components/schemas/ReportRunRelationships' ReportRunIncludes: type: array description: Related resources that can be included when a report run is returned. items: discriminator: propertyName: type mapping: organisations: $ref: '#/components/schemas/Organisation' reports: $ref: '#/components/schemas/Report' oneOf: - $ref: '#/components/schemas/Organisation' - $ref: '#/components/schemas/Report' JSONAPI: type: object description: JSON API response object required: - jsonapi properties: jsonapi: type: object required: - version properties: version: type: string description: The version of the JSON API specification examples: - '1.0' Error: type: object description: An error response properties: id: description: >- A unique identifier for this particular occurrence of the problem. If you encounter this, please provide us with the error ID and we can investigate it on our side. type: string format: uuid examples: - 05fc9c8d-73b9-4697-9337-57f7a567a48f status: description: >- The status code for the error. This might not match the HTTP status code if there are more that one errors to return with different status codes. type: string examples: - '401' - '500' title: description: A human readable title for the error. type: string examples: - You are not authorised to access this resource detail: description: >- Where there is more detail that we can provide outside of the title, we will provide it here. type: string examples: - In order to access this resource, you need the 'admin' role. code: description: >- A unique code for the error that may help us to diagnose the issue. Not all errors have codes, so this is usually empty. type: string examples: - AUTH.001 source: description: A JSON object containing additional information about the error. type: object properties: pointer: description: >- A JSON Pointer to the value in the request that caused the error. type: string examples: - /data/attributes/email parameter: description: >- A string indicating which query parameter in the request caused the error. type: string examples: - include required: - id - status - title ReportRunAttributes: type: object description: Attributes of a report run required: - status - row_count properties: status: $ref: '#/components/schemas/ReportRunStatus' row_count: type: integer format: int64 description: > How many rows the run returned. Zero on a run that was skipped for being empty, and on a failed run, where nothing was counted rather than nothing being found. error: type: - string - 'null' description: Why a failed run failed. Null on a run that did not fail. artifact: oneOf: - $ref: '#/components/schemas/ReportArtifact' - type: 'null' description: >- The file the run produced. Null on a skipped or failed run, which produced none. ReportRunMeta: type: object description: Metadata for a report run required: - scheduled_at - started_at properties: scheduled_at: type: string format: date-time description: > The slot the run was for. On a scheduled run this is the due time rather than the time the dispatcher happened to pick it up, which is what makes a re-dispatch of the same slot recognisable as a duplicate rather than as a second run. started_at: type: string format: date-time description: When the run began. completed_at: type: - string - 'null' format: date-time description: > When the run finished. Always set in practice: a run is recorded once it has finished, so there is no in-progress run to observe and no status describing one. The type stays nullable so that a future partial record has somewhere to go without a breaking change. ReportRunRelationships: type: object description: Relationships for a report run required: - organisation - report properties: organisation: type: object required: - data properties: data: $ref: '#/components/schemas/OrganisationRelationship' report: type: object required: - data properties: data: $ref: '#/components/schemas/ReportRelationship' description: The report this run is one delivery of. Organisation: type: object description: An organisation required: - id - type - attributes - meta properties: id: type: string format: uuid description: The unique identifier of the organisation. type: type: string const: organisations attributes: $ref: '#/components/schemas/OrganisationAttributes' meta: $ref: '#/components/schemas/OrganisationMeta' relationships: $ref: '#/components/schemas/OrganisationRelationships' Report: type: object description: A scheduled delivery of a saved query's results required: - id - type - attributes - meta - relationships properties: id: type: string format: uuid description: The unique identifier of the report. type: type: string const: reports attributes: $ref: '#/components/schemas/ReportAttributes' meta: $ref: '#/components/schemas/ReportMeta' relationships: $ref: '#/components/schemas/ReportRelationships' ReportRunStatus: type: string description: > How a single run of a report ended. `skipped_empty` is a success, not a failure: the report was configured to stay quiet when there is nothing to say, and it did. `failed` means the run could not complete, and the reason is on the run's `error`. enum: - sent - skipped_empty - failed ReportArtifact: type: object description: > The file a run produced, retained so that what was sent stays retrievable and provable. `expired` marks an artifact whose bytes have been swept after the retention window. The run itself is kept indefinitely: it is the delivery record, so its status, row count and delivery attempts outlive the file they describe. required: - filename - content_type - size_bytes - attached - expired properties: filename: type: string description: The name the file was delivered under. content_type: type: string description: The media type of the file. example: text/csv size_bytes: type: integer format: int64 description: The size of the file in bytes. attached: type: boolean description: > Whether the file was attached to the email or linked to. An artifact above the attachment threshold is linked rather than attached, and the recipient downloads it through the authenticated endpoint. expired: type: boolean description: >- Whether the bytes have been swept, leaving the run's record without its file. OrganisationRelationship: type: object description: Represents a relationship to an organisation required: - id - type properties: id: type: string format: uuid description: The unique identifier of the organisation type: type: string const: organisations ReportRelationship: type: object description: Represents a relationship to a report required: - id - type properties: id: type: string format: uuid description: The unique identifier of the report type: type: string const: reports OrganisationAttributes: type: object description: Attributes for an organisation required: - name - slug - sandbox properties: name: type: string description: The name of the organisation. examples: - Acme Construction Ltd slug: type: string description: The URL-friendly identifier for the organisation. examples: - acme-construction description: type: string description: A short description of the organisation. examples: - >- Leading construction company specializing in infrastructure projects sandbox: type: boolean description: Whether the organisation is a sandbox (i.e. a test organisation) examples: - false settings: type: object properties: teams: type: object description: Team-related settings for the organisation. properties: customer_representatives: type: array description: > IDs of teams within this organisation whose members act as customer service representatives. Each entry must reference a team that belongs to this organisation. items: type: string format: uuid uniqueItems: true examples: - - b234c567-8901-2345-6789-abcdef012345 OrganisationMeta: type: object description: Meta information for an organisation required: - v3 - status properties: created_at: type: string format: date-time description: The creation time of the organisation. examples: - '2023-01-15T10:30:00.000Z' updated_at: type: string format: date-time description: The last update time of the organisation. examples: - '2023-02-20T14:45:00.000Z' v3: type: boolean description: Whether the organisation is using version 3 exclusively. examples: - true status: type: string enum: - active - inactive default: active description: The current status of the organisation. examples: - active features: type: array description: Available features and their limits for the organisation. items: type: object properties: name: type: string description: The name of the feature. examples: - advanced_reporting enabled: type: boolean description: Whether the feature is enabled. examples: - true limit: type: integer description: The usage limit for this feature (if applicable). examples: - 1000 OrganisationRelationships: type: object description: Relationships for an organisation properties: users: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/UserRelationship' service_accounts: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/ServiceAccountRelationship' groups: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/UserGroupRelationship' teams: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/TeamRelationship' nomenclature: type: object required: - data properties: data: oneOf: - $ref: '#/components/schemas/NomenclatureRelationship' - type: 'null' ReportAttributes: type: object description: Attributes of a report required: - name - format - schedule - recipients - state properties: name: type: string description: What the report is called, and the subject line recipients see. format: $ref: '#/components/schemas/ReportFormat' schedule: $ref: '#/components/schemas/ReportSchedule' recipients: type: array minItems: 1 description: >- Who the report is delivered to. A report with no recipients cannot be saved. items: $ref: '#/components/schemas/ReportRecipient' options: $ref: '#/components/schemas/ReportOptions' state: $ref: '#/components/schemas/ReportState' paused_reason: type: - string - 'null' description: > Why the report was paused, when it was paused by the system rather than by somebody. Null on an active report and on one a person paused. ReportMeta: type: object description: Metadata for a report required: - created_at - updated_at properties: created_at: type: string format: date-time description: The date and time the report was created. updated_at: type: string format: date-time description: The date and time the report was last updated. next_run_at: type: - string - 'null' format: date-time description: > When the report is next due to run. Null on a paused report, which has no next run until it is resumed. last_run_at: type: - string - 'null' format: date-time description: >- When the report last ran, whatever the outcome. Null before its first run. ReportRelationships: type: object description: Relationships for a report required: - organisation - query - owner properties: organisation: type: object required: - data properties: data: $ref: '#/components/schemas/OrganisationRelationship' query: type: object required: - data properties: data: $ref: '#/components/schemas/QueryRelationship' description: The saved query the report runs. owner: type: object required: - data properties: data: $ref: '#/components/schemas/UserRelationship' description: > Whose access the report runs under. Set to whoever created the report and not caller-supplied: every run executes with this user's real materialised grants, so a report can never surface rows its owner could not see for themselves. UserRelationship: type: object description: Represents a relationship to a user required: - id - type properties: id: type: string format: uuid description: The unique identifier of the user type: type: string const: users ServiceAccountRelationship: type: object description: Represents a relationship to a service account required: - id - type properties: id: type: string format: uuid description: The unique identifier of the service account type: type: string const: service-accounts UserGroupRelationship: type: object description: Represents a relationship to a group required: - id - type properties: id: type: string format: uuid description: The unique identifier of the group type: type: string const: groups TeamRelationship: type: object description: Represents a relationship to a team required: - id - type properties: id: type: string format: uuid description: The unique identifier of the team type: type: string const: teams NomenclatureRelationship: type: object description: Represents a relationship to a nomenclature resource required: - id - type properties: id: type: string format: uuid description: The unique identifier of the nomenclature resource type: type: string const: nomenclature ReportFormat: type: string description: > What the recipients receive. `csv` attaches the whole result set as a spreadsheet. `digest` is a summary email: the headline row count, the first rows as a table, and a link into the console for the rest. enum: - csv - digest ReportSchedule: type: object description: > When a report runs. `time` is interpreted in UK time (Europe/London), the same fixed zone the analytics domain buckets dates and resolves relative-date filters in, so a report's schedule and the figures in it agree. It is resolved per run rather than stored as an offset, so a daylight-saving change is absorbed and 09:00 stays 09:00. Which anchor applies depends on the frequency, and the anchor a frequency does not use is ignored: - `daily` uses `time` alone. - `weekly` uses `day_of_week`. - `fortnightly` uses `day_of_week` and `anchor_date`, which decides which of the two weeks is the running one. - `monthly` uses `day_of_month`. - `quarterly` uses `day_of_month` of the first month of each quarter (January, April, July, October). required: - frequency - time properties: frequency: type: string description: How often the report runs. enum: - daily - weekly - fortnightly - monthly - quarterly time: type: string pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]$ description: The time of day the report runs, as 24-hour HH:MM in UK time. example: '09:00' day_of_week: type: integer minimum: 1 maximum: 7 description: >- The day of the week for a weekly or fortnightly report, ISO-numbered so 1 is Monday and 7 is Sunday. day_of_month: type: integer minimum: 1 maximum: 31 description: > The day of the month for a monthly or quarterly report. A day later than the month contains is clamped to the last day of that month, so 31 means month end in every month rather than being invalid in most of them. anchor_date: type: string format: date description: > Which fortnight a fortnightly report runs in. The report runs in the week containing this date and every second week after it. Required for `fortnightly` and ignored otherwise. ReportRecipient: type: object description: > Somebody a report is delivered to, named either individually or by the team they are in. A team is expanded to its current members at send time rather than when the report is scheduled, so adding somebody to a team starts sending them the report and removing them stops it. required: - type - id properties: type: type: string description: Whether the recipient is one person or a team of them. enum: - user - team id: type: string format: uuid description: The id of the user or team. ReportOptions: type: object description: Delivery behaviour that is not the schedule or the format. properties: skip_empty: type: boolean default: false description: > Send nothing when the run returns no rows, recording the run as `skipped_empty` instead. This is what turns a report into an alert: "email me this week's critical-risk records, but only if there are any". ReportState: type: string description: > Whether the report is running to its schedule. A report is paused either because somebody paused it or because it stopped being able to run as its owner: the owner's account was disabled, their access was revoked, or the organisation was made inactive. The owner is notified when that happens, so a report never goes quiet without saying so. enum: - active - paused QueryRelationship: type: object description: Represents a relationship to a query required: - id - type properties: id: type: string format: uuid description: The unique identifier of the query type: type: string const: queries securitySchemes: Session: description: | Session token for authentication. in: header name: X-Session-Token type: apiKey Cookie: description: | Cookie token for authentication. in: cookie name: ctrl_hub_session type: apiKey OAuth2: description: | OAuth2 token for authentication. flows: clientCredentials: scopes: {} tokenUrl: https://auth.ctrl-hub.com/oauth2/token type: oauth2 ````