SDK Reference
Reports and Digital Forms Scheduled report lifecycle methods and digital form answer retrieval.
Reports and digital form endpoints are dashboard-derived. Use the typed payloads
for common fields and preserve any tenant-specific fields returned by Linxio.
Input params.limitnumber
optional Number of reports to request.
params.pagenumber
optional Page number to request.
Default: 1
params.formatcsv | pdf | xlsx
optional Optional file format filter when Linxio accepts it.
params.startDate / params.endDateISODateString
optional Optional date range filters when supported by the report endpoint.
Returns dataLinxioScheduledReport[] | null
optional Scheduled reports for the requested page.
metaLinxioPaginationMeta | null
optional errorLinxioError | null
optional Typed SDK error when reports cannot be loaded.
const reports = await linxio.reports. scheduled ({ limit: 50 , page: 1 , }); if (reports.error) { throw reports.error; } Input scheduledTemplate() does not take parameters.
Returns dataLinxioRecord | null
optional Dashboard template metadata. Shape can vary by tenant and enabled report types.
errorLinxioError | null
optional Typed SDK error when the template cannot be loaded.
Scheduled report template const template = await linxio.reports. scheduledTemplate (); if (template.error) { throw template.error; } Input Scheduled report identifier.
Returns dataLinxioScheduledReport | null
optional errorLinxioError | null
optional Typed SDK error when the report cannot be loaded.
const report = await linxio.reports. getScheduled (reportId); if (report.error) { throw report.error; } Input payload.namestring
required Scheduled report display name.
payload.typestring
required Report type accepted by Linxio.
payload.formatcsv | pdf | xlsx
required payload.paramsRecord<string, unknown>
optional Report-specific parameters such as recipients, schedule, date range, vehicle IDs, or filters.
Returns dataLinxioScheduledReport | null
optional Created scheduled report.
errorLinxioError | null
optional Typed SDK error when creation fails.
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; } Input Scheduled report identifier.
payloadPartial<LinxioScheduledReportPayload>
required Partial scheduled-report payload containing fields to change.
Returns dataLinxioScheduledReport | null
optional Updated scheduled report.
errorLinxioError | null
optional Typed SDK error when update fails.
const updated = await linxio.reports. updateScheduled (reportId, { name: "Updated Weekly Fleet Summary" , }); if (updated.error) { throw updated.error; } Input Scheduled report identifier.
Returns errorLinxioError | null
optional Typed SDK error when delete fails.
const deleted = await linxio.reports. deleteScheduled (reportId); if (deleted.error) { throw deleted.error; } Input Scheduled report identifier.
Returns errorLinxioError | null
optional Typed SDK error when restore fails.
const restored = await linxio.reports. restoreScheduled (reportId); if (restored.error) { throw restored.error; } Input list() does not take parameters.
Returns dataLinxioDigitalForm[] | null
optional errorLinxioError | null
optional Typed SDK error when forms cannot be loaded.
const forms = await linxio.digitalForms. list (); if (forms.error) { throw forms.error; } Returns dataLinxioDigitalForm | null
optional errorLinxioError | null
optional Typed SDK error when the form cannot be loaded.
const form = await linxio.digitalForms. get (formId); if (form.error) { throw form.error; } Input Digital form answer identifier.
Returns dataLinxioRecord | null
optional Digital form answer payload. Shape varies by form schema.
errorLinxioError | null
optional Typed SDK error when the answer cannot be loaded.
const answer = await linxio.digitalForms. answer (answerId); if (answer.error) { throw answer.error; } Input Digital form answer identifier.
Returns errorLinxioError | null
optional Typed SDK error when the PDF cannot be downloaded.
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); Fuel transaction records, summaries, vehicle fuel rows, cards, fuel types, and transaction assignment.
Routes, Sensors, and Cameras
Vehicle route history, temperature/humidity reports, sensor inventory, and camera event helpers.