Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2025-01-16170291390.7 KB
Task Runs

Task Run History

Query for task run history data across a given range and interval.

post/api/task_runs/history

Headers

x-prefect-api-versionstring

Request body

history_startstring date-time required

The history's start time.

history_endstring date-time required

The history's end time.

history_interval_secondsnumber required

The size of each history interval, in seconds. Must be at least 1 second.

Example request

{
  "flows": {
    "name": {
      "any_": [
        "my-flow-1",
        "my-flow-2"
      ],
      "like_": "marvin"
    },
    "tags": {
      "all_": [
        "tag-1",
        "tag-2"
      ]
    }
  },
  "flow_runs": {
    "name": {
      "any_": [
        "my-flow-run-1",
        "my-flow-run-2"
      ],
      "like_": "marvin"
    },
    "tags": {
      "all_": [
        "tag-1",
        "tag-2"
      ]
    },
    "work_queue_name": {
      "any_": [
        "work_queue_1",
        "work_queue_2"
      ]
    }
  },
  "task_runs": {
    "name": {
      "any_": [
        "my-task-run-1",
        "my-task-run-2"
      ],
      "like_": "marvin"
    },
    "tags": {
      "all_": [
        "tag-1",
        "tag-2"
      ]
    }
  },
  "deployments": {
    "name": {
      "any_": [
        "my-deployment-1",
        "my-deployment-2"
      ],
      "like_": "marvin"
    },
    "tags": {
      "all_": [
        "tag-1",
        "tag-2"
      ]
    },
    "work_queue_name": {
      "any_": [
        "work_queue_1",
        "work_queue_2"
      ]
    }
  }
}

Response

Successful Response

interval_startstring date-time required

The start date of the interval.

interval_endstring date-time required

The end date of the interval.