Sign in

v1

latestOpenAPI 3.1.02026-07-22370342.6 KB
Issues

List Issues

List all issues that have been observed by Terminal. Issues are generated when we observe something that may impact the completeness or accuracy of the data we provide but do not justify a full error. For example, if we lack permissions for a specific resource or need to skip an item due to invalid data.

get/issues

Query parameters

limitinteger

The maximum number of results to return in a page.

cursorstring cursor
Example:cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw

Pagination cursor to start requests from

lastReportedAfterstring date-time

ISO 8601 date

Example:2021-01-06T03:24:53.000Z

Timestamp to start when the issue was last observed

lastReportedBeforestring date-time

ISO 8601 date

Example:2021-01-06T03:24:53.000Z

Timestamp to end when the issue was last observed

expand'connection'

Expand related resources to see all details

connectionIdstring ulid
Example:conn_01GV12VR4DJP70GD1ZBK0SDWFH

Filter issues to a specific connection

errorCode'missing_permissions' | 'exceeded_retention_window' | 'invalid_source_id' | 'unknown_device_type' | 'missing_safety_configuration' | 'inaccessible_data' | 'manually_disabled'

Filter issues to a specific error code

status'ongoing' | 'resolved'

Filter issues to a specific status

Headers

X-Application-Idstring

Scopes the request to a Terminal application in the caller's organization. Required for multi-application organizations when using a user session or OAuth access token. API keys are already bound to a single application.

Response

OK

nextstring cursor

Cursor used for pagination.

Example response

{
  "results": [
    {
      "id": "isu_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "connection": "conn_01GV12VR4DJP70GD1ZBK0SDWFH",
      "error": {
        "message": "Failed to ingest HOS Logs, missing permissions to access Duty Status Logs"
      },
      "firstReportedAt": "2021-01-06T03:24:53.000Z",
      "lastReportedAt": "2021-01-06T03:24:53.000Z"
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}