Get Mismatch Alerts

Lists trailer mismatch observation alerts for the authenticated customer.

Authentication

  • Include your Access-Token and x-api-key in the header of your requests.

Permissions

The external-api-mismatch-observations or admin permission is required to access this endpoint.

Endpoint

  • URL: https://api.genlogs.io/mismatch-observations

  • Method: GET

Headers

  • Access-Token: (string, required): Access token obtained from the "Create Access Token" endpoint.

  • x-api-key (string, required): The API key provided by GenLogs.

Request Example:

curl --location 'https://api.genlogs.io/mismatch-observations?page=1&page_size=5' \
--header 'access-token: <your-api-token>' \
--header 'x-api-key: <your-x-api-key>'

Response:

  • 200 OK: A JSON object containing the list of paginated trailer mismatch alerts.

  • 400 Bad Request: If one of the provided parameters is incorrect.

  • 401 Unauthorized: If the authentication credentials (Access-Token) is missing or incorrect.

  • 403 Forbidden: If the permission has not been set to your user.

  • 500 Internal Server Error: If there is an issue on the server that prevents processing the request.

Response Body:

200 OK

  • mismatch_observations (list): list of trailer mismatch observations including related information.

    • id (str, UUID): unique identifier of the alert.

    • name (str, optional, nullable): alert display name. If not provided when the alert is created, it is set to null.

    • usdot (str, nullable): USDOT value associated with the mismatch observation. null when not applicable.

    • mc (str, nullable): MC value associated with the mismatch observation. null when not applicable.

    • is_disabled (bool): indicates whether the mismatch alert is disabled.

    • created_at (str, date-time): creation timestamp in ISO-8601 format.

    • last_run_at (str, date-time, nullable): last run timestamp in ISO-8601 format.

  • page (int): current page number (1-based).

  • page_size (int): number of items returned per page.

  • total (int): total number of mismatch observations available for the customer.

400 Bad Request

401 Forbidden

403 Forbidden

List mismatch observations

get

Returns mismatch observations for the authenticated customer only, ordered from newest to oldest. Paginated; default page size is 50. Returns 200 with an empty mismatch_observations array when none exist.

Authorizations
Access-TokenstringRequired
x-api-keystringRequired
Query parameters
pageinteger · min: 1Optional

Page number (1-based).

Default: 1
page_sizeinteger · min: 1 · max: 500Optional

Number of items per page (max 500).

Default: 50
Responses
chevron-right
200

Paginated list of mismatch observations for the customer.

application/json
pageinteger · min: 1Required

Current page number.

page_sizeinteger · min: 1 · max: 500Required

Page size used for this response.

totalintegerRequired

Total number of observations for this customer (all pages).

get
/mismatch-observations

Last updated