# Terminal

## Docs

- [Connection Health Monitoring](https://docs.withterminal.com/advanced/connection-health-monitoring.md): Understand the different categories of connection health events, how to monitor them, and what actions to take.
- [Entity Status & Visibility](https://docs.withterminal.com/advanced/entity-status-visibility.md)
- [Authentication](https://docs.withterminal.com/api-reference/authentication.md): Learn how to authenticate with Terminal using API keys and connection tokens
- [Public Token Exchange](https://docs.withterminal.com/api-reference/authentication/public-token-exchange.md): Exchange the `publicToken` returned by our hosted authentication flow for a long lived connection token that will be used when requesting data from a customer's TSP.
- [Get Current Connection](https://docs.withterminal.com/api-reference/connections/get-current-connection.md): Get the details of the current active connection. The current connection is derived from the provided connection token.
- [List All Connections](https://docs.withterminal.com/api-reference/connections/list-connections.md): List all of the connections you have for your application. Connections represent the authenticated access you have to your customer's TSP data.
- [Update Current Connection](https://docs.withterminal.com/api-reference/connections/update-current-connection.md): Update the details of the current active connection. The current connection is derived from the provided connection token.
- [Cancel Sync](https://docs.withterminal.com/api-reference/data-management/cancel-sync.md): Cancel a sync job mid-way through. This is useful for cancelling syncs that are no longer needed. Cancelled syncs will be marked as failed and can be retried.
- [Get Sync Job Status](https://docs.withterminal.com/api-reference/data-management/get-sync-job-status.md): Get the status of a sync job by ID.
- [List Sync History](https://docs.withterminal.com/api-reference/data-management/list-sync-history.md): List a log of all batch sync jobs for the current connection.
- [Passthrough](https://docs.withterminal.com/api-reference/data-management/passthrough.md): Make an authenticated request to the underlying telematics provider.
- [Request Sync](https://docs.withterminal.com/api-reference/data-management/request-sync.md): Manually request to sync the current connections data.
- [Retry Sync](https://docs.withterminal.com/api-reference/data-management/retry-sync.md): Retry a failed sync job with the same parameters. This is useful for retrying syncs that failed due to temporary issues.
- [List Devices](https://docs.withterminal.com/api-reference/devices/list-devices.md): List all devices in the connected account.
- [Get Driver](https://docs.withterminal.com/api-reference/drivers/get-driver.md): Get the details of a specific driver
- [List Drivers](https://docs.withterminal.com/api-reference/drivers/list-drivers.md): List all of the drivers in the connected account
- [Environments](https://docs.withterminal.com/api-reference/environments.md)
- [List Fault Code Events](https://docs.withterminal.com/api-reference/fault-codes/list-fault-code-events.md): List all fault code events detected by the provider.
- [List Groups](https://docs.withterminal.com/api-reference/groups/list-groups.md)
- [Available Time for Drivers](https://docs.withterminal.com/api-reference/hours-of-service/list-hosavailable-time.md): List available time for the driver. This endpoint provides live access to the driver's available time. Different than most endpoints, this endpoint calls the provider's API in real time to get the latest available time for the driver. This endpoint is useful for building real time applications that…
- [List HOS Daily Logs](https://docs.withterminal.com/api-reference/hours-of-service/list-hosdaily-logs.md): List daily summary of hours of service. Each daily log represents the time a driver spent in each duty status for a given day.
- [List HOS Logs](https://docs.withterminal.com/api-reference/hours-of-service/list-hoslogs.md): List all hours of service logs. HOS logs are tracked as the distinct changes in duty status.
- [Get IFTA Summary](https://docs.withterminal.com/api-reference/ifta/get-iftasummary.md): Get all vehicle IFTA reports for the requested time span.
- [List Issues](https://docs.withterminal.com/api-reference/issues/list-issues.md): List all issues that have been observed by Terminal.
- [Resolve Issue](https://docs.withterminal.com/api-reference/issues/resolve-issue.md): Mark an issue's status as `resolved` until the issue is observed again.
- [Pagination](https://docs.withterminal.com/api-reference/pagination.md)
- [List Providers](https://docs.withterminal.com/api-reference/providers/list-providers.md): Retrieve a list of the providers Terminal supports. This endpoint will grow to include additional details about the supported capabilities of each provider.
- [Rate Limits](https://docs.withterminal.com/api-reference/rate-limits.md)
- [Resource Expansion](https://docs.withterminal.com/api-reference/resource-expansion.md)
- [Get Event Camera Media](https://docs.withterminal.com/api-reference/safety/get-event-camera-media.md): Get camera media for a given safety event.
- [Get Safety Event](https://docs.withterminal.com/api-reference/safety/get-safety-event.md): Get a safety event by id.
- [List Safety Events](https://docs.withterminal.com/api-reference/safety/list-safety-events.md): List all safety events detected by the provider.
- [Serialization](https://docs.withterminal.com/api-reference/serialization.md)
- [Latest Trailer Locations](https://docs.withterminal.com/api-reference/trailers/list-latest-trailer-locations.md)
- [List Trailers](https://docs.withterminal.com/api-reference/trailers/list-trailers.md)
- [List Historical Trips](https://docs.withterminal.com/api-reference/trips/list-trips.md): List all historical trips in the connected account. Trips define a period of time where a vehicle is in motion.
- [Get Vehicle Utilization](https://docs.withterminal.com/api-reference/vehicle-utilization/get-vehicle-utilization.md): Get vehicle utilization days containing information about fuel consumption, distance traveled, and operational time metrics.
- [Get Vehicle](https://docs.withterminal.com/api-reference/vehicles/get-vehicle.md): Get the details of a specific vehicle
- [Historical Vehicle Locations](https://docs.withterminal.com/api-reference/vehicles/list-historical-vehicle-locations.md): List the historical breadcrumb locations for a vehicle.
- [Historical Vehicle Stats](https://docs.withterminal.com/api-reference/vehicles/list-historical-vehicle-stats.md): List historical stats and logs about the vehicle.
- [Latest Vehicle Locations](https://docs.withterminal.com/api-reference/vehicles/list-latest-vehicle-locations.md): List the latest location of the vehicles in the connected account.
- [List Vehicles](https://docs.withterminal.com/api-reference/vehicles/list-vehicles.md): List all of the vehicles in the connected account
- [connection.completed](https://docs.withterminal.com/api-reference/webhook-events/connection-completed.md): This event is emitted when a user successfully completes the authentication process.
- [connection.created](https://docs.withterminal.com/api-reference/webhook-events/connection-created.md): Emitted when a connection is succesfully created with a provider account.
- [connection.disconnected](https://docs.withterminal.com/api-reference/webhook-events/connection-disconnected.md): Emitted when a connection is disconnected. This typically happens if credentials are deemed invalid and the user must re-authenticate.
- [connection.first_sync_completed](https://docs.withterminal.com/api-reference/webhook-events/connection-first-sync-completed.md): Emitted when a connection's first successful sync completes.
- [connection.reconnected](https://docs.withterminal.com/api-reference/webhook-events/connection-reconnected.md): Emitted when a connection is succesfully reconnected. This should happen when a customer re-authenticates after being disconnected.
- [connection.updated](https://docs.withterminal.com/api-reference/webhook-events/connection-updated.md): Emitted when a connection's details are updated.
- [delivery.completed](https://docs.withterminal.com/api-reference/webhook-events/delivery-completed.md): Emitted when a delivery completes successfully.
- [delivery.failed](https://docs.withterminal.com/api-reference/webhook-events/delivery-failed.md): Emitted when a delivery fails.
- [delivery.requested](https://docs.withterminal.com/api-reference/webhook-events/delivery-requested.md): Emitted when a delivery is requested.
- [delivery.started](https://docs.withterminal.com/api-reference/webhook-events/delivery-started.md): Emitted when a delivery starts processing.
- [driver.added](https://docs.withterminal.com/api-reference/webhook-events/driver-added.md)
- [driver.modified](https://docs.withterminal.com/api-reference/webhook-events/driver-modified.md)
- [driver.removed](https://docs.withterminal.com/api-reference/webhook-events/driver-removed.md)
- [issue.reported](https://docs.withterminal.com/api-reference/webhook-events/issue-reported.md): Emitted when an issue with a connection has been reported.
- [issue.resolved](https://docs.withterminal.com/api-reference/webhook-events/issue-resolved.md): Emitted when an issue has been manually resolved.
- [Event Types](https://docs.withterminal.com/api-reference/webhook-events/overview.md): Terminal sends webhook events to your server to notify you of events that happen in your Terminal account.
- [safety_event.added](https://docs.withterminal.com/api-reference/webhook-events/safety-event-added.md)
- [safety_event.modified](https://docs.withterminal.com/api-reference/webhook-events/safety-event-modified.md)
- [sync.completed](https://docs.withterminal.com/api-reference/webhook-events/sync-completed.md): Emitted when a connection sync completes successfully.
- [sync.failed](https://docs.withterminal.com/api-reference/webhook-events/sync-failed.md): Emitted when a connection sync has failed to complete successfully.
- [sync.requested](https://docs.withterminal.com/api-reference/webhook-events/sync-requested.md): Emitted when a connection sync has been requested and is queued to run.
- [sync.started](https://docs.withterminal.com/api-reference/webhook-events/sync-started.md): Emitted when a connection sync has started running.
- [unsupported_provider.requested](https://docs.withterminal.com/api-reference/webhook-events/unsupported-provider-requested.md): Emitted when a customer requests an unsupported provider using our Link component.
- [vehicle.added](https://docs.withterminal.com/api-reference/webhook-events/vehicle-added.md)
- [vehicle.modified](https://docs.withterminal.com/api-reference/webhook-events/vehicle-modified.md)
- [vehicle.removed](https://docs.withterminal.com/api-reference/webhook-events/vehicle-removed.md)
- [Changelog](https://docs.withterminal.com/changelog.md)
- [Motive OAuth Configuration](https://docs.withterminal.com/configuration/motive.md): Follow this guide to configure an OAuth2 client for Motive integration
- [Samsara OAuth Configuration](https://docs.withterminal.com/configuration/samsara.md): Here's a step-by-step guide to configure an OAuth2 client for Samsara
- [AWS S3 Destination](https://docs.withterminal.com/destinations/s3.md): Automated data replication to Amazon S3
- [Consent Templates](https://docs.withterminal.com/guides/consent-templates.md): Learn how to create reusable Link configurations for branding, redirects, and ingestion defaults.
- [Disconnected Connections](https://docs.withterminal.com/guides/disconnected-connections.md): Learn how Terminal handles disconnected connections and the workflows available for quick reconnection.
- [Duplicate Connections](https://docs.withterminal.com/guides/duplicate-connections.md): Learn what duplicate connections are and best practices for handling them.
- [Vehicle & Driver Filtering](https://docs.withterminal.com/guides/filtering.md)
- [Fuel Cards](https://docs.withterminal.com/guides/fuel-card-implementation.md): Best practices for implementing Terminal in fuel card workflows, from fleet onboarding through fraud prevention and transaction verification.
- [Getting Started](https://docs.withterminal.com/guides/getting-started.md): Here's a step-by-step guide to get started integrating telematics data with Terminal.
- [Insurance](https://docs.withterminal.com/guides/insurance-implementation.md): Best practices for implementing Terminal in auto insurance workflows, from quoting through policy binding.
- [Migrating to Terminal](https://docs.withterminal.com/guides/migrating-to-terminal.md): This guide outlines how to migrate existing connections from another telematics aggregator or your direct integrations to Terminal.
- [Preparing for Production](https://docs.withterminal.com/guides/preparing-for-production.md): A guide to help ensure your Terminal implementation is ready for production.
- [How to Sync Data](https://docs.withterminal.com/guides/syncing-data.md)
- [Overview](https://docs.withterminal.com/home.md): 👋 Welcome to Terminal's Docs
- [How Terminal Works](https://docs.withterminal.com/introduction.md): Let's introduce you to some key features and concepts of the Terminal API.
- [Link Component](https://docs.withterminal.com/link-component.md): Terminal provides a hosted 'Link' that makes it easy to authenticate with any telematics provider. With only a few steps you will be able to provide customers/partners an easy self-serve flow to connect their telematics account.
- [Camera Media](https://docs.withterminal.com/models/camera-media.md): Video footage from vehicle cameras associated with safety events.
- [Connection](https://docs.withterminal.com/models/connection.md): The connection your application has with your customer's TSP.
- [Device](https://docs.withterminal.com/models/device.md): Type of device installed in a vehicle.
- [Driver](https://docs.withterminal.com/models/driver.md): The model representing a driver in Terminal.
- [Fault Code Event](https://docs.withterminal.com/models/fault-code-event.md): A fault code observed at a specific time
- [Group](https://docs.withterminal.com/models/group.md): A group represents a collection of assets (vehicles, trailers, drivers) defined by the provider.
- [HOS Available Time](https://docs.withterminal.com/models/hosavailable-time.md): The available time left on the clock for a specific driver.
- [HOS Daily Log](https://docs.withterminal.com/models/hosdaily-log.md): Record of daily hours of service.
- [HOS Log](https://docs.withterminal.com/models/hoslog.md): Records a change in duty status by a driver.
- [IFTA Summary](https://docs.withterminal.com/models/iftasummary.md): A report of IFTA data for a specific vehicle. Currently only incremented by full months.
- [IFTA Vehicle Month](https://docs.withterminal.com/models/iftavehicle-month.md): Mileage driven by a vehicle, month and jurisdiction. In the API, this is summarized by the [IFTA Summary](/models/iftasummary) model.
- [Issue](https://docs.withterminal.com/models/issue.md): An issue is a problem we encountered while ingesting data from a connection that may impact the quality or completeness of the data.
- [Latest Trailer Location](https://docs.withterminal.com/models/latest-trailer-location.md): The latest record of a trailer's location according to the provider.
- [Latest Vehicle Location](https://docs.withterminal.com/models/latest-vehicle-location.md): The latest record of a vehicle's location according to the provider.
- [Overview](https://docs.withterminal.com/models/overview.md): Documentation for Terminal's common model schemas
- [Safety Event](https://docs.withterminal.com/models/safety-event.md): A normalized record of a safety-related incident that occurred during a vehicle's operation. These events are detected and recorded by the telematics provider's system.
- [Sync](https://docs.withterminal.com/models/sync.md): An object containing the state of a sync job. This can be polled after connection linking to know when data is available for ingestion.
- [Trailer](https://docs.withterminal.com/models/trailer.md): The model representing a trailer in Terminal.
- [Trip](https://docs.withterminal.com/models/trip.md): Trips define a period of time where a vehicle is in motion. Trips are based on the provider's definition.
- [Vehicle](https://docs.withterminal.com/models/vehicle.md): The model representing a vehicle in Terminal.
- [Vehicle Location](https://docs.withterminal.com/models/vehicle-location.md): A point-in-time record of a vehicle's location.
- [Vehicle Stat Log](https://docs.withterminal.com/models/vehicle-stat-log.md): A point-in-time record of stats and logs for a specific vehicle.
- [Vehicle Utilization](https://docs.withterminal.com/models/vehicle-utilization.md): Vehicle usage metrics for a specific vehicle and date range.
- [Vehicle Utilization Day](https://docs.withterminal.com/models/vehicle-utilization-day.md): Daily vehicle usage metrics for a specific vehicle and date.
- [Provider Explorer](https://docs.withterminal.com/providers/explorer.md)
- [Product Roadmap](https://docs.withterminal.com/roadmap.md)
- [Published SDKs](https://docs.withterminal.com/sdks.md): Terminal provides SDKs to make it easy to integrate with your application.
- [Security](https://docs.withterminal.com/security.md): How we protect customer data
- [Crash Reports](https://docs.withterminal.com/terminal-platform/crash-reports.md): Receive detailed reports when crash events are detected across connections
- [Custom Identifiers](https://docs.withterminal.com/terminal-platform/custom-identifiers.md)
- [Third Party Extensions](https://docs.withterminal.com/terminal-platform/extensions.md)
- [Managed Polling](https://docs.withterminal.com/terminal-platform/managed-polling.md): Terminal polls and caches real-time data from providers
- [Passthrough](https://docs.withterminal.com/terminal-platform/passthrough.md)
- [Raw Data](https://docs.withterminal.com/terminal-platform/raw-data.md)
- [Real-Time Data](https://docs.withterminal.com/terminal-platform/real-time-data.md): Access live telematics data from providers through Terminal
- [Sandbox Environment](https://docs.withterminal.com/terminal-platform/sandbox.md): Test your telematics integrations with Terminal's API
- [Timestamps](https://docs.withterminal.com/terminal-platform/timestamps.md)
- [User Notifications](https://docs.withterminal.com/terminal-platform/user-notifications.md): Receive notifications for key events through your individual account
- [Webhooks](https://docs.withterminal.com/terminal-platform/webhooks.md)

## OpenAPI Specs

- [terminal.openapi](https://docs.withterminal.com/terminal.openapi.json)
- [package](https://docs.withterminal.com/package.json)

## Optional

- [Website](https://withterminal.com)