---
title: "Get a search job's status."
method: GET
path: "/v2/search/jobs/{jobId}"
tags: ["searchJobManagement"]
---

# Get a search job's status.

`GET /v2/search/jobs/{jobId}`

Use the search job identifier to obtain the current status of a search job.

## Path parameters

- `jobId` string, required

## Response `200`

The search job's status.

- SearchJobStatusResponse
  - `warning` string — Warnings value contains the detailed information about the warning while obtaining the current status of a search job.
  - `state` string — Search job state. In case you are checking status for a multi child org query, you might see another status as 'Done Gathering Partial Results' which means that the query failed for some of the child orgs. You can check their reasons in audit logs with the query Id.
  - `histogramBuckets` HistogramBucket[] — Histogram buckets for the query.
    - `startTimestamp` integer, required — Start time of the bucket.
    - `length` integer, required — Length is in milliseconds, tells the width of the bucket.
    - `count` integer, required — Count of messages in this bucket.
    - `logLevel` string — Log level of messages in this bucket.
  - `messageCount` integer — Number of messages found or produced so far.
  - `recordCount` integer — Number of records found or produced so far.
  - `pendingWarnings` string[] — Pending warnings that have accumulated since the last time the status was requested.
  - `pendingErrors` string[] — Pending errors that have accumulated since the last time the status was requested.
  - `usageDetails` object — Usage details about the search job api. It includes data scanned in bytes during the search.
    - `dataScannedInBytes` integer — Data Scanned in Bytes.
  - `usageDetailsByMeteringType` UsageDetailsByMeteringType[] — Usage details broken down by metering type. Each element contains dataScannedInBytes, meteringType, tier, and isChargeable.
    - `dataScannedInBytes` integer, required — Data scanned in bytes for this metering type.
    - `meteringType` string, required — The metering type.
    - `tier` string, required — The analytics tier.
    - `isChargeable` boolean, required — Whether this metering type is chargeable.
  - `usageDetailsByTier` UsageDetailsByTier[] — Usage details broken down by analytics tier. Each element contains dataScannedInBytes and tier.
    - `dataScannedInBytes` integer, required — Data scanned in bytes for this tier.
    - `tier` string, required — The analytics tier.
  - `timeElapsed` integer — Time elapsed in milliseconds since the search job started.
  - `searchedTimeRange` SearchedTimeRange — The time range that has been searched so far.
    - `startMillis` integer — Start of the searched time range in epoch milliseconds.
    - `endMillis` integer — End of the searched time range in epoch milliseconds.
  - `showLogLevels` boolean — Whether log level distribution data is available for this search job.
  - `pendingMessageLocatorsAndOffsets` PendingMessageLocatorsAndOffset[] — Pending message locators and offsets accumulated since the last status request.
    - `messageLocator` MessageLocator, required
      - `blockId` string — The block identifier.
      - `messageId` string — The message identifier.
    - `offset` integer, required — The offset of the message.
  - `jobId` string — The job identifier for this search job.
  - `userMessages` UserMessage[] — Informational user messages generated during the search. Each element contains type, key, and data.
    - `type` string, required — The message type.
    - `key` string, required — The message key.
    - `data` string — The message data as a JSON string.
  - `performance` Performance — Performance characteristics of this search job.
    - `difficulty` 'CALCULATION_DISABLED' | 'Unknown' | 'Easy' | 'Medium' | 'Hard' — The difficulty level of the search query.
    - `reasons` string[] — Reasons explaining the difficulty classification.

## Other responses

- `default` — Operation failed with an error.

---

[API](https://skmtc.net/sumologic/apis/sumo-logic-api.md) · [All operations](https://skmtc.net/sumologic/apis/sumo-logic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sumologic/sumo-logic-api/revisions/88a343690a6e/schema)