History Queries

List all history queries

Retrieves a list of all configured history queries

get/api/history

Response

Array of history query objects

idstring required

The unique identifier of the entity.

createdAtstring required

Represents an instant in time as an ISO 8601 string.

updatedAtstring required

Represents an instant in time as an ISO 8601 string.

namestring required

The name of the history query.

descriptionstring required

Description of the history query's purpose.

status'PENDING' | 'RUNNING' | 'ERRORED' | 'PAUSED' | 'FINISHED' required

Type representing the possible statuses for a history query.

startTimestring required

Start time for the data to be queried (ISO 8601 format).

endTimestring required

End time for the data to be queried (ISO 8601 format).

Type representing the possible types for a South connector.

Type representing the possible types for a North connector.

Example response

[
  {
    "id": "entity123",
    "createdBy": {
      "id": "abc123",
      "friendlyName": "John Doe (john.doe)"
    },
    "updatedBy": {
      "id": "abc123",
      "friendlyName": "John Doe (john.doe)"
    },
    "createdAt": "2023-10-31T12:34:56.789Z",
    "updatedAt": "2023-10-31T12:34:56.789Z",
    "name": "Production Data Migration",
    "description": "Migrate production data from old to new system",
    "startTime": "2023-01-01T00:00:00Z",
    "endTime": "2023-01-31T23:59:59Z"
  }
]

Changes

Changed in 23 of the 73 revisions of this API.122031

Jul 28, 20269a6250881fa71See the full diff
- ●
  added the new influxdb enum value to the items/southType response property for the response status 200
  response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 26, 2026ea1c80cb9c691See the full diff
- ○
  removed the influxdb enum value from the items/southType response property for the response status 200
  response-property-enum-value-removed
This revision also has 29 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 20, 20266a232346b1581See the full diff
- ●
  added the new influxdb enum value to the items/southType response property for the response status 200
  response-property-enum-value-added
Jul 15, 202657cbe043ec5a1See the full diff
- ○
  removed the influxdb enum value from the items/southType response property for the response status 200
  response-property-enum-value-removed
This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 6, 20264c50d4a73f661See the full diff
- ●
  added the new influxdb enum value to the items/southType response property for the response status 200
  response-property-enum-value-added
Jul 3, 2026a460443e789e1See the full diff
- ○
  removed the influxdb enum value from the items/southType response property for the response status 200
  response-property-enum-value-removed
This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 29, 2026ea736a81a9311See the full diff
- ●
  added the new influxdb enum value to the items/southType response property for the response status 200
  response-property-enum-value-added
Jun 24, 20262c78cb2da6471See the full diff
- ○
  removed the influxdb enum value from the items/southType response property for the response status 200
  response-property-enum-value-removed
This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 22, 2026748932ded1271See the full diff
- ●
  added the new influxdb enum value to the items/southType response property for the response status 200
  response-property-enum-value-added
Jun 18, 2026f4c06376e0381See the full diff
- ○
  removed the influxdb enum value from the items/southType response property for the response status 200
  response-property-enum-value-removed
This revision also has 22 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history (23 revisions)