Eagle Eye Networks VSP Visits API

openapi: 3.2.0
info:
  title: VEHICLE SURVEILLANCE PACKAGE VSP Visits API
  version: 3.0.0
  description: Visit tracking and session management for LPR events at site-level.
servers:
- url: https://{BaseUrl}/api/v3.0
  description: Eagle Eye Networks API Server
  variables:
    BaseUrl:
      default: api.cxxx.eagleeyenetworks.com
      description: HTTPS Base url to use for all API calls, retrieved from https://api.eagleeyenetworks.com/api/v3.0/clientSettings
security:
- bearerAuth: []
tags:
- name: VSP Visits
  description: Visit tracking and session management for LPR events at site-level.
paths:
  /vspVisits:
    get:
      operationId: listVspVisits
      tags:
      - VSP Visits
      description: 'Retrieve visit records with optional filtering by plate or event ID. Visit sessions are created by pairing

        LPR entry/exit events within a site location.'
      parameters:
      - $ref: '#/components/parameters/plate2'
      - $ref: '#/components/parameters/plate__fuzzy1'
      - $ref: '#/components/parameters/locationId__in'
      - $ref: '#/components/parameters/eventId'
      - $ref: '#/components/parameters/pageToken'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: List of visit records matching search criteria
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VspVisitsResult'
              examples:
                Complete Visit:
                  value:
                    results:
                    - id: 123e4567-e89b-12d3-a456-426614174000
                      accountId: '12345678'
                      locationId: acd0dd1-05a0-4d75-a14b-30e0f4083c70
                      plate: ABC123
                      entry:
                        timestamp: '2026-01-09T08:30:00.000+00:00'
                        eventId: f99e57ca-b6aa-4919-a0e6-73355cf18c9e
                        cameraId: 100abcde
                      exit:
                        timestamp: '2026-01-09T10:15:00.000+00:00'
                        eventId: 3e4df856-11e8-46dd-90c8-2e228d771a16
                        cameraId: 100abcdf
                      durationSec: 6300
                      state: complete
                    nextPageToken: ''
                    prevPageToken: ''
                In Progress Visit:
                  value:
                    results:
                    - id: 223e4567-e89b-12d3-a456-426614174010
                      accountId: '12345678'
                      locationId: acd0dd1-05a0-4d75-a14b-30e0f4083c70
                      plate: XYZ789
                      entry:
                        timestamp: '2026-01-09T14:30:00.000+00:00'
                        eventId: f99e57ca-b6aa-4919-a0e6-73355cf18c9e
                        cameraId: 100abcde
                      state: inProgress
                    nextPageToken: ''
                    prevPageToken: ''
                Incomplete Visit:
                  value:
                    results:
                    - id: 323e4567-e89b-12d3-a456-426614174020
                      accountId: '12345678'
                      locationId: acd0dd1-05a0-4d75-a14b-30e0f4083c70
                      plate: DEF456
                      exit:
                        timestamp: '2026-01-09T12:00:00.000+00:00'
                        eventId: 3e4df856-11e8-46dd-90c8-2e228d771a16
                        cameraId: 100abcdf
                      state: incomplete
                    nextPageToken: ''
                    prevPageToken: ''
        '400':
          $ref: '#/components/responses/validationError'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '500':
          $ref: '#/components/responses/internalServerError'
      summary: List vsp visits
      x-summary-source: derived
components:
  schemas:
    ErrorInfoExceptionDetail:
      properties:
        type:
          description: A string enum describing the type of detail object.
          type: string
          enum:
          - errorInfo
        reason:
          description: 'The reason for the error. This is a constant value that identifies the proximate cause of the

            error. Error reasons are unique within a particular domain of errors.

            '
          type: string
          enum:
          - unauthenticated
          - unexpectedArgument
          - missingRequiredArgument
          - wrongArgumentValue
          - invalidPermission
          - wrongEdition
          - wrongAccountType
          - resourceNotFound
          - endpointNotFound
          - methodNotSupported
          - unexpectedError
          - acceptNotSupported
          - alreadyExists
          - foreignKeyConflict
          - childDevicesExist
          - contentNotSupported
          - deadlineExpired
          - tooManyRequests
          - deviceUnavailable
          - serviceUnavailable
          - invalidJSON
          - resourceLocked
          - notSupportedOnBridge
          - outOfRetention
          - deviceIdentificationFailed
          - credentialValidationFailed
          - credentialSetupFailed
          - localUrlValidationFailed
          - hwRegistrationFailed
          - failedAddingCameraAfterValidation
          - neverConnected
          - reconnectFailed
          - unsupportedModel
          - purged
          - userBlocked
          - userTemporarilyBlocked
          - quotaExceeded
          - alreadyValidated
          - reAuthenticationRequired
          - badGateway
        domain:
          description: 'Logical grouping to which the "reason" belongs

            '
          type: string
        metadata:
          $ref: '#/components/schemas/ExceptionMetadata'
    ExceptionDetail:
      type: object
      oneOf:
      - $ref: '#/components/schemas/ErrorInfoExceptionDetail'
      - $ref: '#/components/schemas/BadRequestExceptionDetail'
      - $ref: '#/components/schemas/ResourceInfoExceptionDetail'
      discriminator:
        propertyName: type
        mapping:
          errorInfo: '#/components/schemas/ErrorInfoExceptionDetail'
          badRequest: '#/components/schemas/BadRequestExceptionDetail'
          resourceInfo: '#/components/schemas/ResourceInfoExceptionDetail'
      properties:
        type:
          description: A string enum describing the type of detail object.
          type: string
          enum:
          - errorInfo
          - badRequest
          - resourceInfo
      required:
      - type
    ApiV3Error:
      type: object
      properties:
        code:
          description: HTTP code defined in EEN Standard Code Values
          type: integer
        status:
          description: A string enum describing the code
          type: string
          enum:
          - cancelled
          - unknown
          - invalidArgument
          - deadlineExceeded
          - notFound
          - conflict
          - permissionDenied
          - resourceExhausted
          - failedPrecondition
          - aborted
          - outOfRange
          - unimplemented
          - internal
          - unavailable
          - dataLoss
          - unauthenticated
          - mediaTypeNotSupported
          - acceptNotSupported
          - methodNotSupported
          - tooManyRequests
          - badGateway
        message:
          description: Developer friendly human readable error message in English
          type: string
        details:
          description: An array of extensible objects that define error information
          type: array
          items:
            $ref: '#/components/schemas/ExceptionDetail'
      required:
      - code
      - status
      - message
      - details
    BadRequestExceptionDetail:
      properties:
        type:
          description: A string enum describing the type of detail object.
          type: string
          enum:
          - badRequest
        argumentViolations:
          type: array
          items:
            $ref: '#/components/schemas/ArgumentViolation'
    VisitEvent:
      type: object
      description: Details of an entry or exit event within a visit
      properties:
        timestamp:
          type: string
          format: date-time
          description: Timestamp of the entry or exit event
          example: '2026-01-09T08:30:00.000+00:00'
        eventId:
          type: string
          description: LPR event ID associated with this entry or exit
          example: f99e57ca-b6aa-4919-a0e6-73355cf18c9e
        cameraId:
          type: string
          description: Camera ID that captured the entry or exit event
          example: 100abcde
      required:
      - timestamp
      - eventId
      - cameraId
    ResourceInfoExceptionDetail:
      properties:
        type:
          description: A string enum describing the type of detail object.
          type: string
          enum:
          - resourceInfo
        resource:
          description: Referenced resource type, eg "cameras", "bridges", or "locations".
          type: string
        ids:
          type: array
          description: Identities of resources
          items:
            type: string
    VspVisit:
      type: object
      description: A visit session created by pairing LPR entry and exit events within a site
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the visit record
          example: 123e4567-e89b-12d3-a456-426614174000
        accountId:
          type: string
          description: Account ID associated with the visit
          example: '12345678'
        locationId:
          type: string
          description: Location ID where the visit occurred
          example: acd0dd1-05a0-4d75-a14b-30e0f4083c70
        plate:
          type: string
          description: License plate number of the vehicle
          example: ABC123
        entry:
          allOf:
          - $ref: '#/components/schemas/VisitEvent'
          description: Entry event details (only present when entry was recorded)
        exit:
          allOf:
          - $ref: '#/components/schemas/VisitEvent'
          description: Exit event details (only present when exit was recorded)
        durationSec:
          type:
          - integer
          - 'null'
          description: Duration of the visit in seconds
          example: 6300
        state:
          type: string
          description: 'Visit state:

            - `complete`: Entry and exit events successfully paired

            - `inProgress`: Entry event recorded, awaiting matching exit

            - `incomplete`: Exit without matching entry, or entry timed out after 24 hours'
          enum:
          - complete
          - inProgress
          - incomplete
          example: complete
      required:
      - id
      - accountId
      - locationId
      - plate
      - state
    ArgumentViolation:
      properties:
        argumentName:
          type: string
          description: Name of the argument
        description:
          type: string
          description: Description of the violation
    ExceptionMetadata:
      properties:
        path:
          description: Path of the request
          type: string
        method:
          description: Method of the request
          type: string
    VspVisitsResult:
      allOf:
      - $ref: '#/components/schemas/PaginatedResponse'
      - type: object
        properties:
          results:
            type: array
            items:
              $ref: '#/components/schemas/VspVisit'
    PaginatedResponse:
      type: object
      description: 'Used to wrap results for a paginated response, containing information on how to retrieve further pages and, if  available, the total number of results.

        '
      properties:
        nextPageToken:
          type:
          - string
          - 'null'
          readOnly: true
          description: 'Token to retrieve the next page. The value of this token is passed into the field pageToken.  This value can be null if there is no next page.

            '
        prevPageToken:
          type:
          - string
          - 'null'
          readOnly: true
          description: 'Token to retrieve the previous page. The value of this token is passed into the field pageToken.  This value can be null of there is no previous page.

            '
        totalSize:
          type:
          - integer
          - 'null'
          minimum: 0
          readOnly: true
          description: 'The number of resource entries being returned from the result set.  This can be omitted if the API endpoint does not have total size information.

            '
        results:
          type: array
          readOnly: true
          description: The result set from a collection API call.
          items:
            type: object
      required:
      - nextPageToken
      - prevPageToken
      - results
  responses:
    forbidden:
      description: You have no permission to access the specified resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiV3Error'
          examples:
            invalidPermission:
              value:
                code: 403
                status: permissionDenied
                message: The client caller does not have permission for the specified operation
                details:
                - type: errorInfo
                  reason: invalidPermission
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
            wrongEdition:
              value:
                code: 403
                status: permissionDenied
                message: This feature is not enabled for the account
                details:
                - type: errorInfo
                  reason: wrongEdition
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/locations
            wrongAccountType:
              value:
                code: 403
                status: permissionDenied
                message: This feature is only available for end users
                details:
                - type: errorInfo
                  reason: wrongAccountType
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/locations
    internalServerError:
      description: Something went wrong in the server. Please try again.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiV3Error'
          example:
            code: 500
            status: internal
            message: An internal error has occurred. Please try again later.
            details:
            - type: errorInfo
              reason: unexpectedError
              domain: apiv3
              metadata:
                path: /api/v3.0/<resource>
    unauthorized:
      description: You are not authenticated. Please authenticate and try again.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiV3Error'
          example:
            code: 401
            status: unauthenticated
            message: The client caller does not have a valid authentication credential
            details:
            - type: errorInfo
              reason: unauthenticated
              domain: apiv3
              metadata:
                path: /api/v3.0/<resource>
    validationError:
      description: The supplied object is invalid. Error detail will contain the validation error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiV3Error'
          examples:
            unexpectedArgument:
              value:
                code: 400
                status: invalidArgument
                message: 'Unexpected argument: name'
                details:
                - type: errorInfo
                  reason: unexpectedArgument
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
            missingRequiredArgument:
              value:
                code: 400
                status: invalidArgument
                message: 'Missing required arguments: name, id'
                details:
                - type: errorInfo
                  reason: missingRequiredArgument
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
            badRequestInvalidJSON:
              value:
                code: 400
                status: invalidArgument
                message: Invalid JSON
                details:
                - type: errorInfo
                  reason: invalidJSON
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
            badRequestInvalidArgument:
              value:
                code: 400
                status: invalidArgument
                message: 'Invalid Argument: Argument name is too long'
                details:
                - type: errorInfo
                  reason: wrongArgumentValue
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
                - type: badRequest
                  argumentViolations:
                  - argumentName: name
                    description: Name is too long
  parameters:
    plate__fuzzy1:
      in: query
      name: plate__fuzzy
      description: Filter by license plate number with fuzzy matching (up to 1 edit distance)
      schema:
        type: string
      example: ABC123
    pageSize:
      in: query
      name: pageSize
      description: 'The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and  maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a `nextPageToken` value.

        '
      example: 100
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 500
        default: 100
    plate2:
      in: query
      name: plate
      description: Filter by license plate number (exact match)
      schema:
        type: string
      example: ABC123
    locationId__in:
      in: query
      name: locationId__in
      style: form
      explode: false
      description: Filter visits within specified location IDs
      schema:
        type: array
        items:
          type: string
      example:
      - acd0dd1-05a0-4d75-a14b-30e0f4083c70
      - d0e4aad4-06c5-4c43-a4ac-3106738ed206
    eventId:
      in: query
      name: eventId
      description: Find visit containing this entry or exit event ID
      schema:
        type: string
      example: f99e57ca-b6aa-4919-a0e6-73355cf18c9e
    pageToken:
      in: query
      name: pageToken
      description: 'Token string value that references a page for pagination. This value is received when retrieving the first page in the `nextPageToken` and `prevPageToken` fields.

        When a pageToken is provided, the backend remembers search parameters from the original request, so search  parameters that affect the result set or order are optional and will be ignored if provided. Representation  parameters like `include` should still be applied.

        '
      example: b2Zmc2V0PTEwJmxpbWl0PTEw
      required: false
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-provenance:
  method: searched
  source: https://developer.eagleeyenetworks.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.eagleeyenetworks.com/reference/addlpralertconditionrule.md
  - https://developer.eagleeyenetworks.com/reference/addvehicle.md
  - https://developer.eagleeyenetworks.com/reference/addvehiclelist.md
  - https://developer.eagleeyenetworks.com/reference/addvehicles.md
  - https://developer.eagleeyenetworks.com/reference/deletelpralertconditionrule.md
  - https://developer.eagleeyenetworks.com/reference/deletevehicle.md
  - https://developer.eagleeyenetworks.com/reference/deletevehiclelist.md
  - https://developer.eagleeyenetworks.com/reference/getlpralertconditionrule.md
  - https://developer.eagleeyenetworks.com/reference/getlpralertconditionrulefieldvalues.md
  - https://developer.eagleeyenetworks.com/reference/getlprevent.md
  - https://developer.eagleeyenetworks.com/reference/getlpreventssummary.md
  - https://developer.eagleeyenetworks.com/reference/getvehicle.md
  - https://developer.eagleeyenetworks.com/reference/getvehiclelist.md
  - https://developer.eagleeyenetworks.com/reference/getvehiclelistfields.md
  - https://developer.eagleeyenetworks.com/reference/getvehiclelistfieldvalues.md
  - https://developer.eagleeyenetworks.com/reference/listlpralertconditionrules.md
  - https://developer.eagleeyenetworks.com/reference/listlpreventfieldvalues.md
  - https://developer.eagleeyenetworks.com/reference/listlprevents.md
  - https://developer.eagleeyenetworks.com/reference/listvehiclelists.md
  - https://developer.eagleeyenetworks.com/reference/listvehicles.md
  - https://developer.eagleeyenetworks.com/reference/listvspvisits.md
  - https://developer.eagleeyenetworks.com/reference/searchvehiclelists.md
  - https://developer.eagleeyenetworks.com/reference/updatelpralertconditionrule.md
  - https://developer.eagleeyenetworks.com/reference/updatevehicle.md
  - https://developer.eagleeyenetworks.com/reference/updatevehiclelist.md
  merge:
    pages: 25
    deduped: 604
    conflicts_kept_first: 0