Green Screens AI Analytics API

# harvested: 2026-09-12
# method: searched
# source: https://connect.greenscreens.ai/analytics/v1/openapi.yaml
# note: >-
#   Verbatim first-party OpenAPI served from the provider's own documentation host connect.greenscreens.ai. Ownership confirmed: info.contact.email support@greenscreens.ai, x-logo static.greenscreens.ai, servers[] api.greenscreens.ai; termsOfService points at triumph.io because Triumph Financial acquired Greenscreens.ai (closed 2025) and the product now ships as Triumph Intelligence.
openapi: 3.0.2
info:
  title: Analytics
  version: 1.7.1
  description: Analytics service v1
  x-logo:
    url: https://static.greenscreens.ai/main-logo.svg
    backgroundColor: "#fafafa"
    altText: Triumph Intelligence
  termsOfService: https://triumph.io/terms-of-service/
  contact:
    name: API Support
    email: support@greenscreens.ai
    url: https://connect.intelligence.triumph.io
tags:
  - name: Analytics
    description: Analytics related endpoints
paths:
  /analytics/lane-top-carriers:
    get:
      tags:
        - Analytics
      operationId: analyticsLaneTopCarriers
      summary: Top carriers
      description: Returns a list of top carriers for a provided lane
      security:
        - bearerAuth: []
      parameters:
        - in: query
          name: transportType
          schema:
            $ref: "#/components/schemas/TransportType"
          required: true
        - in: query
          name: originCountry
          schema:
            type: string
            example: US
          description: |
            Origin country. 
            Two letter country code in ISO 3166-1 alpha-2 format
        - in: query
          name: originState
          schema:
            type: string
            example: NY
          description: Origin state
          required: true
        - in: query
          name: originCity
          schema:
            type: string
            example: Schenectady
          description: Origin city
          required: true
        - in: query
          name: originZip
          schema:
            type: string
            example: "12345"
          description: Origin area zip
          required: true
        - in: query
          name: destinationCountry
          schema:
            type: string
            example: US
          description: |
            Destination country. 
            Two letter country code in ISO 3166-1 alpha-2 format
        - in: query
          name: destinationState
          schema:
            type: string
            example: IL
          description: Destination state
          required: true
        - in: query
          name: destinationCity
          schema:
            type: string
            example: Chicago
          description: Destination city
          required: true
        - in: query
          name: destinationZip
          schema:
            type: string
            example: "60636"
          description: Destination area zip
          required: true
        - in: query
          name: hasExtraStops
          schema:
            type: boolean
            example: true
            description: |
              Signifies whether the requested lane has extra stops or not.

              If true, multistop loads will be included during calculations.
            default: false
        - in: query
          name: dateFrom
          schema:
            type: string
            format: date
            example: "2019-09-30"
          description: >
            Start date of a period for which you want to calculate top
            carriers. 

            In ISO format (YYYY-MM-DD). 


            End date of this period is the current date.
          required: true
        - in: query
          name: region
          schema:
            type: string
            enum:
              - CITY
              - CITY_ZIP
              - ZIP_CITY
              - ZIP
              - 3DZIP
              - KMA
            description: >
              Determines the size of the area around the origin and destination
              points, 

              that will be searched for the related data.

              * CITY - narrow, city wide, area

              * ZIP - narrow, five digit zip, area

              * 3DZIP - medium, short zip, area

              * KMA - big, market wide, area

              * CITY_ZIP - a special option that sets origin area to CITY and destination area to ZIP

              * ZIP_CITY - a special option that sets origin area to ZIP and destination area to CITY
            example: ZIP
          required: true
        - in: query
          name: currency
          schema:
            type: string
            example: USD
          description: >
            Code of the currency that you want the response to be in.

            Format is ISO 4217.

            If not provided, defaults to the currency set in the profile of currently authenticated user.
        - in: query
          name: sort
          schema:
            type: array
            items:
              type: string
          description: >
            Sorting descriptor in format `?sort={field},{asc|desc}`. 


            Multiple sort parameters are allowed and should look like this 

            `?sort=name,asc&sort=email,desc`.


            If multiple sort parameters are passed, the results will be sorted by all of them, 

            with priority decreasing from left to right.


            So in case of `?sort=name,asc&sort=volume,desc` results will be first sorted by 

            name in ascending order, and in cases where names are equal 

            results will be sorted by volume in descending order.


            By default carriers are sorted like this: 

            `numberOfLoads,desc & lastShippedDate,desc`.


            These response fields support sorting:

            ```

            carrierName

            carrierPhone

            carrierEmail

            carrierMC

            carrierDOT

            carrierSCAC

            numberOfLoads

            lastShippedDate

            averageCarrierRate

            minCarrierRate

            maxCarrierRate

            averageCarrierFlatRate

            minCarrierFlatRate

            maxCarrierFlatRate

            averageCarrierMarginPercent

            ```
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AnalyticsLaneCarriersResponse"
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: A common api error object
                properties:
                  code:
                    type: string
                    description: unique string identifier of the error
                  message:
                    type: string
                    description: human readable error message
                required:
                  - code
                  - message
                example:
                  code: invalid_request
                  message: Your ClientId is invalid
              examples:
                error400Example:
                  value:
                    code: missing_required_parameter
                    message: Your request was missing a {par_name} parameter
        "401":
          description: Unauthenticated
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/paths/~1analytics~1lane-top-carriers/get/responses/400/content/applica\
                  tion~1json/schema"
              examples:
                error403Example:
                  value:
                    code: access_forbidden
                    message: Access is forbidden
        "404":
          description: Item not found
          content:
            application/json:
              schema:
                $ref: "#/paths/~1analytics~1lane-top-carriers/get/responses/400/content/applica\
                  tion~1json/schema"
              examples:
                error404Example:
                  value:
                    code: item_not_found
                    message: Item not found
        "422":
          description: Unprocessable Entity with multiple errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                  message:
                    type: string
                  errors:
                    type: array
                    description: list of errors
                    items:
                      type: object
                      description: Request validation error
                      properties:
                        field:
                          type: string
                          description: Name of the field that did not pass validation
                          example: transportType
                        message:
                          type: string
                          description: Human readable error mesage explaining why validation failed
                          example: SpaceXDragon transportType is not supported. Valid values are [VAN,
                            FLATBED, ...]
                        value:
                          type: string
                          nullable: true
                          description: Value of the field that did not pass validation
                          example: SpaceXDragon
                      required:
                        - field
                        - message
                required:
                  - code
                  - message
                  - errors
                example:
                  code: request_validation
                  message: You have one or more errors in request structure
                  errors:
                    - field: carrierName
                      message: field contains wrong data type (int), should be string
                      value: "22"
                    - field: shipperId
                      message: "shipperId: must not be null"
                      value: null
                    - field: loadSource.loadId
                      message: "loadId: must not be null"
                      value: null
              examples:
                error422MultiExample:
                  value:
                    code: request_validation
                    message: You have one or more errors in request structure
                    errors:
                      - field: carrierName
                        message: field contains wrong data type (int), should be string
                        value: "22"
                      - field: shipperId
                        message: "shipperId: must not be null"
                        value: null
                      - field: loadSource.loadId
                        message: "loadId: must not be null"
                        value: null
        "429":
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: "#/paths/~1analytics~1lane-top-carriers/get/responses/400/content/applica\
                  tion~1json/schema"
              examples:
                error429TooManyRequests:
                  value:
                    code: too_many_requests
                    message: Request limit exceeded
        "500":
          description: Unhandled server error
          content:
            application/json:
              schema:
                $ref: "#/paths/~1analytics~1lane-top-carriers/get/responses/400/content/applica\
                  tion~1json/schema"
              examples:
                error500Example:
                  value:
                    code: internal_error
                    message: Internal server error
  /analytics/lane-triumph-carriers:
    get:
      tags:
        - Analytics
      operationId: analyticsLaneTriumphCarriers
      summary: Triumph carriers
      description: Returns a list of Triumph carriers for a provided lane
      security:
        - bearerAuth: []
      parameters:
        - in: query
          name: transportType
          schema:
            $ref: "#/components/schemas/TransportType"
          required: true
        - name: originMarketCode
          in: query
          required: false
          schema:
            $ref: "#/components/schemas/MarketCode"
        - name: destinationMarketCode
          in: query
          required: false
          schema:
            $ref: "#/components/schemas/MarketCode"
        - in: query
          name: originState
          schema:
            type: string
            example: NY
          description: Origin state
          required: false
        - in: query
          name: originCity
          schema:
            type: string
            example: Schenectady
          description: Origin city
          required: false
        - in: query
          name: originZip
          schema:
            type: string
            example: "12345"
          description: Origin area zip, 3 or 5 digits
          required: false
        - in: query
          name: destinationState
          schema:
            type: string
            example: IL
          description: Destination state
          required: false
        - in: query
          name: destinationCity
          schema:
            type: string
            example: Chicago
          description: Destination city
          required: false
        - in: query
          name: destinationZip
          schema:
            type: string
            example: "60636"
          description: Destination area zip, 3 or 5 digits
          required: false
        - in: query
          name: responseGranularity
          schema:
            $ref: "#/components/schemas/ResponseGranularity"
          required: false
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            default: 100
            minimum: 1
            maximum: 1000
          description: Number of items to return
        - name: pageNumber
          in: query
          required: false
          schema:
            type: integer
            default: 0
            minimum: 0
          description: Page number (zero-based)
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AnalyticsLaneTriumphCarriersResponse"
        "400":
          $ref: "#/paths/~1analytics~1lane-top-carriers/get/responses/400"
        "401":
          $ref: "#/paths/~1analytics~1lane-top-carriers/get/responses/401"
        "403":
          $ref: "#/paths/~1analytics~1lane-top-carriers/get/responses/403"
        "404":
          $ref: "#/paths/~1analytics~1lane-top-carriers/get/responses/404"
        "422":
          $ref: "#/paths/~1analytics~1lane-top-carriers/get/responses/422"
        "429":
          $ref: "#/paths/~1analytics~1lane-top-carriers/get/responses/429"
        "500":
          $ref: "#/paths/~1analytics~1lane-top-carriers/get/responses/500"
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
  schemas:
    AnalyticsLaneCarriersResponse:
      type: object
      description: Analytics lane carriers response
      properties:
        items:
          type: array
          description: List of carriers
          maxItems: 10
          items:
            $ref: "#/components/schemas/AnalyticsLaneCarrierItem"
      required:
        - items
    AnalyticsLaneTriumphCarriersResponse:
      type: object
      description: Analytics lane carriers response
      properties:
        responseGranularity:
          $ref: "#/components/schemas/ResponseGranularity"
        originMarketCode:
          $ref: "#/components/schemas/MarketCode"
        destinationMarketCode:
          $ref: "#/components/schemas/MarketCode"
        originCity:
          type: string
          description: Origin city
          example: Chicago
        originState:
          type: string
          description: Origin state
          example: IL
        originZip:
          type: string
          description: Origin zip, 3 or 5 digits following requested zip
          example: "60636"
        destinationCity:
          type: string
          description: Destination city
          example: Houston
        destinationState:
          type: string
          description: Destination state
          example: TX
        destinationZip:
          type: string
          description: Destination zip, 3 or 5 digits following requested zip
          example: "73264"
        transportType:
          $ref: "#/components/schemas/TransportType"
        items:
          type: array
          description: List of carriers
          items:
            $ref: "#/components/schemas/AnalyticsLaneTriumphCarrierItem"
        pagination:
          $ref: "#/components/schemas/Pagination"
      required:
        - items
    AnalyticsLaneCarrierItem:
      type: object
      properties:
        carrierName:
          type: string
          description: Carrier Name
          example: Eagle One Delivery
        carrierPhone:
          type: string
          description: Carrier phone
          example: "121331343"
        carrierEmail:
          type: string
          description: Carrier email
          example: test@carrier.com
        carrierMC:
          type: string
          description: Motor Carrier number of this carrier
          example: MC00334234
        carrierDOT:
          type: string
          description: Department of Transportation number of this carrier
          example: USDOT33136
        carrierSCAC:
          type: string
          description: Standard Carrier Alpha Code of this carrier
          example: MAEU
        numberOfLoads:
          type: integer
          description: Number of loads that this carrier handled
          example: 41
        lastShippedDate:
          type: string
          description: Date of the last time this carrier handled a load. In ISO date
            format (YYYY-MM-DD).
          format: date
          example: "2019-09-30"
        carriedMultistopLoadsBefore:
          type: boolean
          description: Signifies whether this carrier has ever carried a multistop load
            before
          example: false
        lastCarrierRate:
          type: number
          description: Rate that was paid to this carrier for the last handled load (per
            mile)
          example: 2.1254
        averageCarrierRate:
          type: number
          description: Average rate paid to this carrier (per mile)
          example: 2.1254
        minCarrierRate:
          type: number
          description: Minimum rate paid to this carrier (per mile)
          example: 2.1254
        maxCarrierRate:
          type: number
          description: Maximum rate paid to this carrier (per mile)
          example: 2.1254
        lastCarrierFlatRate:
          type: number
          description: Flat rate that was paid to this carrier for the last handled load
          example: 1340
        averageCarrierFlatRate:
          type: number
          description: Average flat rate paid to this carrier
          example: 1250
        minCarrierFlatRate:
          type: number
          description: Minimum flat rate paid to this carrier
          example: 1200
        maxCarrierFlatRate:
          type: number
          description: Maximum flat rate paid to this carrier
          example: 1350
        averageCarrierMarginPercent:
          type: number
          description: Average margin percent for this carrier
          example: 15
        currency:
          type: string
          description: Code of the currency of the response. Format is ISO 4217.
          example: USD
        performanceMetrics:
          $ref: "#/components/schemas/PerformanceMetricsObject"
      required:
        - carrierName
        - numberOfLoads
        - lastShippedDate
        - carriedMultistopLoadsBefore
        - lastCarrierRate
        - averageCarrierRate
        - minCarrierRate
        - maxCarrierRate
        - lastCarrierFlatRate
        - averageCarrierFlatRate
        - minCarrierFlatRate
        - maxCarrierFlatRate
        - averageCarrierMarginPercent
        - currency
    AnalyticsLaneTriumphCarrierItem:
      type: object
      properties:
        carrierName:
          type: string
          description: Carrier Name
          example: Eagle One Delivery
        carrierPhone:
          type: string
          description: Carrier phone
          example: "121331343"
        carrierEmail:
          type: string
          description: Carrier email
          example: test@carrier.com
        carrierMC:
          type: string
          description: Motor Carrier number of this carrier
          example: MC00334234
        carrierDOT:
          type: string
          description: Department of Transportation number of this carrier
          example: USDOT33136
        performanceMetrics:
          $ref: "#/components/schemas/PerformanceMetricsObject"
        transportTypes:
          type: array
          description: List of transport types this carrier is known to support
          items:
            $ref: "#/components/schemas/TransportType"
      required:
        - carrierName
        - performanceMetrics
    AnalyticsLaneResponse:
      type: object
      title: AnalyticsLaneResponse
      properties:
        coverTime:
          type: integer
          description: Time (average) to cover the lane in hours
          example: 247
        laneMarginPercent:
          type: number
          description: Margin per lane (last month, average)
          example: 15.21
        laneUrgency:
          type: integer
          description: Time (average) between pickup and book in hours
          example: 287
        travelTime:
          type: integer
          description: Travel time in hours
          example: 49
        mileage:
          type: number
          description: Mileage in miles
          example: 978
    AnalyticsLaneHighwayCarriersResponse:
      type: object
      description: Highway carriers response
      properties:
        highwayCarrierListUrl:
          type: string
          description: Url to a lane search screen in the Highway app
          example: https://gohighway.com/broker/carriers/lane-search
        carriers:
          type: array
          description: List of carriers returned by the Highway platform
          maxItems: 20
          items:
            $ref: "#/components/schemas/AnalyticsLaneHighwayCarriersResponseItem"
      required:
        - highwayCarrierListUrl
        - carriers
    AnalyticsLaneHighwayCarriersResponseItem:
      type: object
      description: >
        Carrier data provided by the Highway platform. 

        Only available if the current company is a client of the Highway platform.
      properties:
        name:
          type: string
          description: Name of the carrier company
          example: COIN LLC
        headquartersStateCode:
          type: string
          description: Code of the state where company headquarters are based
          example: WA
        dot:
          type: string
          description: Department of Transportation (DOT) number of this carrier
          example: "01467586"
        mc:
          type: string
          description: Motor Carrier number (MC) of this carrier
          example: "554398"
        email:
          type: string
          description: Carrier dispatch email
          example: carrier@mail.com
        phone:
          type: string
          description: Carrier dispatch phone number
          example: "4112228888"
        laneCertainty:
          $ref: "#/components/schemas/HighwayLaneCertainty"
        fleet:
          type: number
          description: >
            Number of trailers in this carriers fleet that match the transport
            type

            in the request
          example: 48
        assessment:
          type: string
          enum:
            - PASS
            - PARTIAL_PASS
          description: Carrier assesment result
          example: PARTIAL_PASS
        highwayCarrierViewUrl:
          type: string
          description: Url to a carrier profile screen in the Highway app
          example: https://gohighway.com/broker/carriers/28661
    HighwayLaneCertainty:
      type: object
      description: |
        Lane certainty info for this carrier for requested lane
      properties:
        observed:
          $ref: "#/components/schemas/HighwayCertaintyLevel"
        preferred:
          $ref: "#/components/schemas/HighwayCertaintyLevel"
        headquarters:
          $ref: "#/components/schemas/HighwayCertaintyLevel"
    HighwayCertaintyLevel:
      type: string
      enum:
        - LOW
        - MEDIUM
        - HIGH
      description: Certainty level
      example: LOW
    AnalyticsLaneCargoChiefCarriersResponse:
      type: object
      description: Cargo Chief carriers response
      properties:
        cargoChiefCarrierListUrl:
          type: string
          description: Url to a carrier search screen in the Cargo Chief app
          example: https://cargochief.app/search/capacity?...
        carriers:
          type: array
          description: List of Cargo Chief carriers matched for this lane
          maxItems: 20
          items:
            $ref: "#/components/schemas/AnalyticsLaneCargoChiefCarriersResponseItem"
      required:
        - carriers
    AnalyticsLaneCargoChiefCarriersResponseItem:
      type: object
      description: >
        Carrier data provided by the Cargo Chief platform. 

        Only available if the current company is a client of the Cargo Chief platform.
      properties:
        name:
          type: string
          description: Carrier company name
          example: Eagle One Delivery
        inNetwork:
          type: boolean
          description: |
            Signifies whether this carrier is in the user's Cargo Chief network
          example: true
        headquartersStateCode:
          type: string
          description: Code of the state where company headquarters are based
          example: WA
        dot:
          type: string
          description: Department of Transportation (DOT) number of this carrier
          example: USDOT33136
        mc:
          type: string
          description: Motor Carrier (MC) number of this carrier
          example: MC00334234
        contacts:
          $ref: "#/components/schemas/CargoChiefCarrierContacts"
        rating:
          type: integer
          description: Cargo Chief platform carrier rating for this lane + carrier match
          example: 75
        cargoChiefCarrierViewUrl:
          type: string
          description: Url to a carrier view screen in the Cargo Chief app
          example: https://cargochief.app/carrier/T2ZmaWNlOjIxMTE0NjIw
    CargoChiefCarrierContacts:
      type: object
      description: Cargo Chief carrier contacts info
      properties:
        name:
          type: string
          description: Contact name
          example: James
        email:
          type: string
          description: Contact email
          example: test@carrier.com
        phone:
          type: string
          description: Contact phone number
          example: "121331343"
    AnalyticsLaneYatCarriersResponse:
      type: object
      description: Yat.ai carriers response
      properties:
        yatCarrierListUrl:
          type: string
          description: Url to a carrier search screen in the Yat.ai app
          example: https://portal.yat.ai/search/capacity?...
        carriers:
          type: array
          description: List of Yat.ai carriers
          maxItems: 20
          items:
            $ref: "#/components/schemas/AnalyticsLaneYatCarriersResponseItem"
      required:
        - carriers
    AnalyticsLaneYatCarriersResponseItem:
      type: object
      description: >
        Carrier data provided by the Yat.ai platform. 

        Only available if the current company is a client of the Yat.ai platform.
      properties:
        name:
          type: string
          description: Carrier company name
          example: Eagle One Delivery
        headquartersStateCode:
          type: string
          description: Code of the state where company headquarters are based
          example: WA
        dot:
          type: string
          description: Department of Transportation (DOT) number of this carrier
          example: "01467586"
        mc:
          type: string
          description: Motor Carrier number (MC) of this carrier
          example: "554398"
        fleet:
          type: integer
          description: Number of trucks in this carriers fleet
          example: 48
        contacts:
          $ref: "#/components/schemas/YatCarrierContacts"
        score:
          $ref: "#/components/schemas/YatCarrierScore"
        yatCarrierViewUrl:
          type: string
          description: Url to a carrier profile screen in the Yat.ai app
          example: https://portal.yat.ai/carriers/28661
    YatCarrierContacts:
      type: object
      description: Yat.ai carrier contacts info
      properties:
        email:
          type: string
          description: Contact email
          example: test@carrier.com
        phone:
          type: string
          description: Contact phone number
          example: "121331343"
    YatCarrierScore:
      type: object
      description: Yat.ai carrier match score info
      properties:
        normalizedScore:
          type: number
          description: >
            Normalized score, this is the result of combining other scores in
            this object
          example: 99.8374
        sizeScore:
          type: number
          description: |
            Size score
          example: 88.9431
        originScore:
          type: number
          description: |
            Origin score
          example: 97.7236
        destinationScore:
          type: number
          description: |
            Destination score
          example: 79.6748
        relationshipScore:
          type: number
          description: |
            Relationship score
          example: 0
        laneScore:
          type: number
          description: |
            Lane score
          example: 75.2846
    AnalyticsLaneCarrierSourceCarriersResponse:
      type: object
      description: CarrierSource carriers response
      properties:
        carrierSourceCarrierListUrl:
          type: string
          description: Url to a lane search screen in the CarrierSource app
          example: https://carriersource.is/lane-search
        carriers:
          type: array
          description: List of carriers returned by the CarrierSource platform
          maxItems: 20
          items:
            $ref: "#/components/schemas/AnalyticsLaneCarrierSourceCarriersResponseItem"
      required:
        - carrierSourceCarrierListUrl
        - carriers
    AnalyticsLaneCarrierSourceCarriersResponseItem:
      type: object
      description: >
        Carrier data provided by the CarrierSource platform. 

        Only available if the current company is a client of the CarrierSource platform
      properties:
        name:
          type: string
          description: Name of the carrier company
          example: COIN LLC
        dot:
          type: string
          description: Department of Transportation (DOT) number of this carrier
          example: "01467586"
        contacts:
          $ref: "#/components/schemas/CarrierSourceCarrierContacts"
        rating:
          $ref: "#/components/schemas/CarrierSourceCarrierRating"
        carrierSourceCarrierViewUrl:
          type: string
          description: Url to a carrier profile screen in the CarrierSource app
          example: https://www.carriersource.io/carriers/p-h-services-inc
    CarrierSourceCarrierContacts:
      type: object
      description: CarrierSource carrier contacts info
      properties:
        email:
          type: string
          description: Carrier dispatch email
          example: carrier@mail.com
        phone:
          type: string
          description: Carrier dispatch phone number
          example: "121331343"
    CarrierSourceCarrierRating:
      ty

# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/green-screens-ai/refs/heads/main/openapi/green-screens-ai-analytics-api-openapi.yml