Skip to content
Console(opens in a new tab)

backgroundTask

Returns a background task by its ID, such as the file export that a search with `output` starts.

Intent. This intent is a read. It returns data and changes nothing.

Returns a background task by its ID, such as the file export that a search with output starts. It returns null for a task that a different API key created.

backgroundTask(id: String!): BackgroundTask

Returns BackgroundTask.

Argument Type Description
id String! The ID of the background task, from extensions.backgroundTasks in the response that started the task.

This intent needs an ID from an earlier answer, so the reference does not run it. Replace the ID with one from your own account.

query {
backgroundTask(id: "00000000-0000-4000-8000-000000000001") {
id
status
progressPercentComplete
result
}
}