> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.hellotracks.com/llms.txt > Use this file to discover all available pages before exploring further. # Preview a report > Builds a report right away and returns its model (tables limited to 50 rows) and its first page as HTML; with format csv the HTML is the CSV table. team-week and mileage read only the first 40 people (and 400 places) in a preview; the model says when it was sampled. The body is a ReportRequest, either directly or wrapped as {"request": {...}}. Admins, operators and the company key may call it; workers get 403 permission_denied. jobs, form-answers and visit-report need a Dispatch plan (403 on a Location plan). Same {data, error, meta} envelope; errors here use the codes invalid_request (400), permission_denied (403) and internal_error (500). ## OpenAPI ````yaml v1/openapi.json POST /reports/preview openapi: 3.1.0 info: title: Hellotracks REST API version: '1' description: >- Plain REST resources over HTTPS, for tools, automations and services. The ht command line is built on it. contact: email: api@hellotracks.com servers: - url: https://api.hellotracks.com/v1 security: - ApiKey: [] tags: - name: Sign-up and sign-in description: >- Create a company or get an API key by an emailed code, without a key; and check which account a key belongs to. - name: Company description: The company the API key belongs to, with its settings and teams. - name: Members description: 'The people in the company: admins, operators and workers.' - name: API keys description: 'The company''s API keys: list, create, revoke and delete.' - name: Jobs description: 'Jobs: work at a location on a date, assigned to a member.' - name: Places description: 'Places: customer sites and other saved locations with a check-in radius.' - name: Zones description: 'Zones: the company''s geofences.' - name: Routing description: Route optimization for one member's day. - name: ETA pages description: >- Live ETA pages (eta.page links) that show a job's recipient when the worker arrives. - name: Maps description: Rendered maps as GeoJSON, and public map share links. - name: Timesheets description: Clock-in and clock-out entries of members, with totals, and editing them. - name: Forms description: >- Form templates, submitted forms, attachments for file and image fields, and forms linked to places and jobs. - name: Alerts description: >- Alert rules (configs) that watch members, places and zones, and the alerts (instances) they raised. - name: Reports description: >- Reports: the newer reporting API (catalog, preview, run, saved) and the older one (types, generate, jobs, uploads, recurring). - name: Webhooks description: URLs Hellotracks calls when jobs, check-ins, clock-ins or alerts happen. paths: /reports/preview: post: tags: - Reports summary: Preview a report description: >- Builds a report right away and returns its model (tables limited to 50 rows) and its first page as HTML; with format csv the HTML is the CSV table. team-week and mileage read only the first 40 people (and 400 places) in a preview; the model says when it was sampled. The body is a ReportRequest, either directly or wrapped as {"request": {...}}. Admins, operators and the company key may call it; workers get 403 permission_denied. jobs, form-answers and visit-report need a Dispatch plan (403 on a Location plan). Same {data, error, meta} envelope; errors here use the codes invalid_request (400), permission_denied (403) and internal_error (500). operationId: previewReport requestBody: required: true content: application/json: schema: oneOf: - type: object properties: request: $ref: '#/components/schemas/ReportRequest' required: - request - $ref: '#/components/schemas/ReportRequest' example: request: report: timesheet view: perPerson period: lastWeek compare: true who: kind: people teamIds: [] memberUids: - a1b2c3 places: kind: all field: '' value: '' teamIds: [] placeUids: [] options: {} format: xlsx responses: '200': description: OK content: application/json: schema: allOf: - $ref: '#/components/schemas/Envelope' properties: data: type: object properties: model: type: object description: >- The report's data: title, period, figures and tables (rows limited to 50). html: type: string columns: type: array description: Columns that can be picked (pickable reports only). items: type: object properties: key: type: string label: type: string standard: type: boolean example: data: model: report: timesheet title: Timesheet html:
...
columns: - key: member label: Member standard: true error: null meta: path: /v1/reports/preview method: POST '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/ServerError' components: schemas: ReportRequest: type: object description: >- What a report is asked for. A period is either a relative period (resolved against the company's today when the report runs) or fixed days fromDay/untilDay. With neither, last week is used. The period may not be longer than the report's maxDays. required: - report properties: report: type: string enum: - team-week - jobs - place-visits - timesheet - mileage - alerts - form-answers - visit-report view: type: string description: One of the report's views; empty = the first view. period: type: string enum: - today - yesterday - thisWeek - lastWeek - thisMonth - lastMonth - last7Days - last30Days description: Weeks start on Monday; "last" periods never include today. fromDay: type: integer description: >- First day as a number YYYYMMDD (e.g. 20261001). Used when period is empty. example: 20261001 untilDay: type: integer description: Last day as a number YYYYMMDD, inclusive. example: 20261031 compare: type: boolean default: true description: Compare with the period before. who: type: object description: People in the report. Missing = everyone the caller may see. properties: kind: type: string enum: - everyone - teams - people default: everyone teamIds: type: array items: type: integer memberUids: type: array items: type: string places: type: object description: >- Places in the report (reports with the places scope). Missing = all active places. properties: kind: type: string enum: - all - field - teams - list default: all field: type: string description: Custom field name, for kind field. value: type: string description: Custom field value, for kind field. teamIds: type: array items: type: integer placeUids: type: array items: type: string jobId: type: string description: The job, for visit-report. options: type: object additionalProperties: type: string description: >- Report options; values are read as strings. Known keys: language (e.g. "de"), formId (form template id, form-answers), status (jobs filter, comma-separated), table (which table the CSV holds), columns (a list of {key, name}, as JSON text or an array). format: type: string enum: - pdf - xlsx - csv - json description: >- For preview: csv shows the CSV table; for run: used when formats is empty. Envelope: type: object properties: data: description: The payload. error: type: 'null' meta: $ref: '#/components/schemas/Meta' Meta: type: object properties: path: type: string description: The request path, without /v1. example: /jobs method: type: string example: GET ErrorEnvelope: type: object properties: data: type: 'null' error: $ref: '#/components/schemas/Error' meta: $ref: '#/components/schemas/Meta' Error: type: object required: - code - message properties: code: type: string description: Stable error code for programs. enum: - invalid_request - invalid_format - invalid_data - invalid_api_key - unknown_user - authentication_failed - forbidden - not_found - already_exists - throttled - not_ready - clock_invalid - force_logout - internal_error - unknown_error message: type: string description: Why it failed, for people. responses: BadRequest: description: The request is invalid. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: data: null error: code: invalid_request message: date must be YYYY-MM-DD meta: path: /jobs method: GET Unauthorized: description: The API key is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: data: null error: code: invalid_api_key message: Invalid Hellotracks API key. meta: path: /jobs method: GET Forbidden: description: The key may not do this. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: data: null error: code: forbidden message: No permission. meta: path: /jobs method: GET TooManyRequests: description: Too many requests; slow down. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: data: null error: code: throttled message: Too many requests. meta: path: /jobs method: GET ServerError: description: Hellotracks failed; retry later. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: data: null error: code: internal_error message: Hellotracks API is temporarily unavailable. meta: path: /jobs method: GET securitySchemes: ApiKey: type: apiKey in: header name: API-Key description: >- Your API key, from More → API & Integrations in the dashboard, or from ht signup / ht auth login. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.