HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for HERE Tracking Events API

7 actions 7 updates phrasing extends openapi/here-events-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for HERE's API. It is a proposal applied on top of the contract, not a document HERE publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info

$.paths['/events/v3/health'].get

$.paths['/events/v3/version'].get

$.paths['/events/v3'].get

$.paths['/events/v3/{trackingId}'].get

$.paths['/events/v3/statuses'].get

$.paths['/events/v3/statuses/deviceCounts'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for HERE Tracking Events API
  version: 1.0.0
extends: openapi/here-events-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/events/v3/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the Events service health
      effect: read
      questions:
      - Is the HERE Tracking Events service up right now?
      - Can I ping the Events service before sending it requests?
      instructions:
      - text: Check the health of the Events service.
      - text: Tell me whether the Events service is healthy.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/events/v3/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Events service version
      effect: read
      questions:
      - What version of the Events service is deployed?
      - Which build of the Events service am I talking to?
      instructions:
      - text: Get the version of the Events service.
      - text: Show me which Events service version is running.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/events/v3'].get
  update:
    x-apievangelist-phrasing:
      intent: List event history across a project
      effect: read
      questions:
      - What events have all my devices and shipments triggered recently?
      - Can I filter project events by event type or rule?
      instructions:
      - text: List all events in project {projectId}.
        slots:
          projectId: query.projectId
      - text: Show project events of type {eventType} after {after}.
        slots:
          eventType: query.eventType
          after: query.after
      method: generated
      generated: '2026-10-01'
- target: $.paths['/events/v3/{trackingId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List event history for one device or shipment
      effect: read
      questions:
      - What events has a single tracker or shipment triggered?
      - Can I see a shipment's geofence events in a time window?
      instructions:
      - text: List events for device {trackingId}.
        slots:
          trackingId: path.trackingId
      - text: Show events for tracker {trackingId} between {after} and {before}.
        slots:
          trackingId: path.trackingId
          after: query.after
          before: query.before
      method: generated
      generated: '2026-10-01'
- target: $.paths['/events/v3/statuses'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the latest event state of each device
      effect: read
      questions:
      - What is the current event state of each of my devices?
      - Which devices are currently inside a given geofence?
      instructions:
      - text: Get the current event statuses for project {projectId}.
        slots:
          projectId: query.projectId
      - text: Show the latest event status for geofence {geofenceId}.
        slots:
          geofenceId: query.geofenceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/events/v3/statuses/deviceCounts'].get
  update:
    x-apievangelist-phrasing:
      intent: Count devices in each event state
      effect: read
      questions:
      - How many devices are in each event state per rule?
      - Can I get counts of trackers currently above a temperature threshold?
      instructions:
      - text: Count devices per event state in project {projectId}.
        slots:
          projectId: query.projectId
      - text: Count devices in each event state grouped by {groupBy}.
        slots:
          groupBy: query.groupBy
      method: generated
      generated: '2026-10-01'