Reports and Digital Forms

Reports and digital form endpoints are dashboard-derived. Use the typed payloads for common fields and preserve any tenant-specific fields returned by Linxio.

reports.scheduled()

GET

List scheduled reports

/scheduled-reportlinxio.reports.scheduled(params)

Loads one page of scheduled reports.

Input

object

optional

Object parameter. Expand to see child parameters.

Show child parameters

number

optional

Number of reports to request.

number

optional

Page number to request.

Default: 1

LinxioFileFormat

optional

Optional file format filter when Linxio accepts it.

Possible enum values

csv

Comma-separated values export.

pdf

PDF export.

xlsx

Excel workbook export.

ISODateString

optional

Optional date range filters when supported by the report endpoint.

Returns

LinxioScheduledReport[] | null

optional

Scheduled reports for the requested page.

Show child fields

LinxioFileFormat

optional

Report output format.

Possible enum values

csv

Comma-separated values export.

pdf

PDF export.

xlsx

Excel workbook export.

LinxioId

required

Scheduled report identifier.

string

optional

Scheduled report display name.

active | disabled | string

optional

Scheduled report status.

string

optional

Scheduled report type.

LinxioPaginationMeta | null

optional

Pagination metadata.

Show child fields

number

required

Page size.

number

required

Current page number.

number

required

Total matching record count.

LinxioError | null

optional

Typed SDK error when reports cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

List scheduled reports

const reports = await linxio.reports.scheduled({
  limit: 50,
  page: 1,
});

if (reports.error) {
  throw reports.error;
}

Example response


{
  "data": [
    {
      "format": "json",
      "id": 64553,
      "name": "Example",
      "status": "online",
      "type": "Truck"
    }
  ],
  "meta": {
    "limit": 100,
    "page": 1,
    "total": 2
  },
  "error": null
}

reports.scheduledTemplate()

GET

Get scheduled report template

/scheduled-report/templatelinxio.reports.scheduledTemplate()

Fetches the scheduled-report template used by the dashboard.

Input

void

optional

scheduledTemplate() does not take parameters.

Returns

LinxioRecord | null

optional

Dashboard template metadata. Shape can vary by tenant and enabled report types.

LinxioError | null

optional

Typed SDK error when the template cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

reports.getScheduled()

GET

Get a scheduled report

/scheduled-report/{reportId}linxio.reports.getScheduled(reportId)

Fetches one scheduled report by ID.

Input

LinxioId

required

Scheduled report identifier.

Returns

LinxioScheduledReport | null

optional

Scheduled report record.

Show child fields

LinxioFileFormat

optional

Report output format.

Possible enum values

csv

Comma-separated values export.

pdf

PDF export.

xlsx

Excel workbook export.

LinxioId

required

Scheduled report identifier.

string

optional

Scheduled report display name.

active | disabled | string

optional

Scheduled report status.

string

optional

Scheduled report type.

LinxioError | null

optional

Typed SDK error when the report cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Get scheduled report

const report = await linxio.reports.getScheduled(reportId);

if (report.error) {
  throw report.error;
}

Example response


{
  "data": {
    "format": "json",
    "id": 64553,
    "name": "Example",
    "status": "online",
    "type": "Truck"
  },
  "error": null
}

reports.createScheduled()

POST

Create a scheduled report

/scheduled-reportlinxio.reports.createScheduled(payload)

Creates a scheduled report.

Input

object

optional

Object parameter. Expand to see child parameters.

Show child parameters

string

required

Scheduled report display name.

string

required

Report type accepted by Linxio.

LinxioFileFormat

required

Output format.

Possible enum values

csv

Comma-separated values export.

pdf

PDF export.

xlsx

Excel workbook export.

Record<string, unknown>

optional

Report-specific parameters such as recipients, schedule, date range, vehicle IDs, or filters.

Returns

LinxioScheduledReport | null

optional

Created scheduled report.

Show child fields

LinxioFileFormat

optional

Report output format.

Possible enum values

csv

Comma-separated values export.

pdf

PDF export.

xlsx

Excel workbook export.

LinxioId

required

Scheduled report identifier.

string

optional

Scheduled report display name.

active | disabled | string

optional

Scheduled report status.

string

optional

Scheduled report type.

LinxioError | null

optional

Typed SDK error when creation fails.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Create scheduled report

const created = await linxio.reports.createScheduled({
  name: "Weekly Fleet Summary",
  type: "fleet-summary",
  format: "pdf",
  params: {
    timezone: "Australia/Perth",
  },
});

if (created.error) {
  throw created.error;
}

Example response


{
  "data": {
    "format": "json",
    "id": 64553,
    "name": "Example",
    "status": "online",
    "type": "Truck"
  },
  "error": null
}

reports.updateScheduled()

PATCH

Update a scheduled report

/scheduled-report/{reportId}linxio.reports.updateScheduled(reportId, payload)

Updates a scheduled report.

Input

LinxioId

required

Scheduled report identifier.

Partial<LinxioScheduledReportPayload>

required

Partial scheduled-report payload containing fields to change.

Show child parameters

LinxioFileFormat

required

Report output format.

Possible enum values

csv

Comma-separated values export.

pdf

PDF export.

xlsx

Excel workbook export.

string

required

Scheduled report display name.

Record<string, unknown>

optional

Report-specific parameter object.

string

required

Scheduled report type.

Returns

LinxioScheduledReport | null

optional

Updated scheduled report.

Show child fields

LinxioFileFormat

optional

Report output format.

Possible enum values

csv

Comma-separated values export.

pdf

PDF export.

xlsx

Excel workbook export.

LinxioId

required

Scheduled report identifier.

string

optional

Scheduled report display name.

active | disabled | string

optional

Scheduled report status.

string

optional

Scheduled report type.

LinxioError | null

optional

Typed SDK error when update fails.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Update scheduled report

const updated = await linxio.reports.updateScheduled(reportId, {
  name: "Updated Weekly Fleet Summary",
});

if (updated.error) {
  throw updated.error;
}

Example response


{
  "data": {
    "format": "json",
    "id": 64553,
    "name": "Example",
    "status": "online",
    "type": "Truck"
  },
  "error": null
}

reports.deleteScheduled()

DELETE

Delete a scheduled report

/scheduled-report/{reportId}linxio.reports.deleteScheduled(reportId)

Deletes a scheduled report.

Input

LinxioId

required

Scheduled report identifier.

Returns

void

optional

Undefined on success.

LinxioError | null

optional

Typed SDK error when delete fails.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

reports.restoreScheduled()

PATCH

Restore a scheduled report

/scheduled-report/{reportId}/restorelinxio.reports.restoreScheduled(reportId)

Restores a scheduled report when the dashboard-derived restore endpoint is available.

Input

LinxioId

required

Scheduled report identifier.

Returns

void

optional

Undefined on success.

LinxioError | null

optional

Typed SDK error when restore fails.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

digitalForms.list()

GET

List digital forms

/digital-form/formlinxio.digitalForms.list()

Lists digital forms visible to the authenticated account.

Input

void

optional

list() does not take parameters.

Returns

LinxioDigitalForm[] | null

optional

Digital form records.

Show child fields

LinxioId

required

Digital form identifier.

string

optional

Digital form display name.

string

optional

Digital form status.

LinxioError | null

optional

Typed SDK error when forms cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

List digital forms

const forms = await linxio.digitalForms.list();

if (forms.error) {
  throw forms.error;
}

Example response


{
  "data": [
    {
      "id": 64553,
      "name": "Example",
      "status": "online"
    }
  ],
  "error": null
}

digitalForms.get()

GET

Get a digital form

/digital-form/form/{formId}linxio.digitalForms.get(formId)

Fetches one digital form by ID.

Input

LinxioId

required

Digital form identifier.

Returns

LinxioDigitalForm | null

optional

Digital form record.

Show child fields

LinxioId

required

Digital form identifier.

string

optional

Digital form display name.

string

optional

Digital form status.

LinxioError | null

optional

Typed SDK error when the form cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Get digital form

const form = await linxio.digitalForms.get(formId);

if (form.error) {
  throw form.error;
}

Example response


{
  "data": {
    "id": 64553,
    "name": "Example",
    "status": "online"
  },
  "error": null
}

digitalForms.answer()

GET

Get a form answer

/digital-form/answer/{answerId}linxio.digitalForms.answer(answerId)

Fetches a digital form answer record.

Input

LinxioId

required

Digital form answer identifier.

Returns

LinxioRecord | null

optional

Digital form answer payload. Shape varies by form schema.

LinxioError | null

optional

Typed SDK error when the answer cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

digitalForms.answerPdf()

GET

Download a form answer PDF

/digital-form/answer/{answerId}/pdflinxio.digitalForms.answerPdf(answerId)

Downloads a digital form answer as a PDF Blob.

Input

LinxioId

required

Digital form answer identifier.

Returns

Blob | null

optional

PDF binary data.

LinxioError | null

optional

Typed SDK error when the PDF cannot be downloaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Download answer PDF

import { writeFile } from "node:fs/promises";

const pdf = await linxio.digitalForms.answerPdf(answerId);

if (pdf.error) {
  throw pdf.error;
}

const bytes = new Uint8Array(await pdf.data.arrayBuffer());
await writeFile("answer.pdf", bytes);

Example response


{
  "data": "<binary>",
  "error": null
}

Reports and Digital Forms

List scheduled reports

Input

Returns

Get scheduled report template

Input

Returns

Get a scheduled report

Input

Returns

Create a scheduled report

Input

Returns

Update a scheduled report

Input

Returns

Delete a scheduled report

Input

Returns

Restore a scheduled report

Input

Returns

List digital forms

Input

Returns

Get a digital form

Input

Returns

Get a form answer

Input

Returns

Download a form answer PDF

Input

Returns

On this page