---
title: "Get analysis status and results"
method: GET
path: "/analyze-text/jobs/{jobId}"
---

# Get analysis status and results

`GET /analyze-text/jobs/{jobId}`

Get the status of an analysis job. A job can consist of one or more tasks. After all tasks succeed, the job transitions to the succeeded state and results are available for each task.

## Path parameters

- `jobId` string, uuid, required

## Query parameters

- `api-version` string, required
- `showStats` boolean
- `top` integer
- `skip` integer

## Response `200`

The request has succeeded.

- AnalyzeTextJobState — The object containing the analyze job LRO job state.
  - `displayName` string — display name
  - `createdDateTime` string, date-time, required — Date and time job created
  - `expirationDateTime` string, date-time — Date and time job expires
  - `jobId` string, uuid, required — Universally Unique Identifier
  - `lastUpdatedDateTime` string, date-time, required — last updated date and time
  - `status` 'notStarted' | 'running' | 'succeeded' | 'partiallyCompleted' | 'failed' | 'cancelled' | 'cancelling', required — The status of the task at the mentioned last update time.
  - `errors` Error[] — errors
    - `code` 'InvalidRequest' | 'InvalidArgument' | 'Unauthorized' | 'Forbidden' | 'NotFound' | 'ProjectNotFound' | 'OperationNotFound' | 'AzureCognitiveSearchNotFound' | 'AzureCognitiveSearchIndexNotFound' | 'TooManyRequests' | 'AzureCognitiveSearchThrottling' | 'AzureCognitiveSearchIndexLimitReached' | 'InternalServerError' | 'ServiceUnavailable' | 'Timeout' | 'QuotaExceeded' | 'Conflict' | 'Warning', required — Human-readable error code.
    - `message` string, required — A human-readable representation of the error.
    - `target` string — The target of the error.
    - `details` Error[] — An array of details about specific errors that led to this reported error.
    - `innererror` InnerErrorModel — An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
      - `code` 'InvalidRequest' | 'InvalidParameterValue' | 'KnowledgeBaseNotFound' | 'AzureCognitiveSearchNotFound' | 'AzureCognitiveSearchThrottling' | 'ExtractionFailure' | 'InvalidRequestBodyFormat' | 'EmptyRequest' | 'MissingInputDocuments' | 'InvalidDocument' | 'ModelVersionIncorrect' | 'InvalidDocumentBatch' | 'UnsupportedLanguageCode' | 'InvalidCountryHint', required — Human-readable error code.
      - `message` string, required — Error message.
      - `details` object — Error details.
      - `target` string — Error target.
      - `innererror` InnerErrorModel — recursive
  - `nextLink` string — next link
  - `tasks` Tasks, required — Container for the tasks status for the LRO job.
    - `completed` integer, required — Count of completed tasks.
    - `failed` integer, required — Count of failed tasks.
    - `inProgress` integer, required — Count of inprogress tasks.
    - `total` integer, required — Count of total tasks.
    - `items` AnalyzeTextLROResult[] — Enumerable of Analyze text job results.
      - `lastUpdateDateTime` string, date-time, required — The last updated time in UTC for the task.
      - `status` 'notStarted' | 'running' | 'succeeded' | 'partiallyCompleted' | 'failed' | 'cancelled' | 'cancelling', required — The status of the task at the mentioned last update time.
      - `taskName` string — task name
      - `kind` 'SentimentAnalysisLROResults' | 'EntityRecognitionLROResults' | 'PiiEntityRecognitionLROResults' | 'KeyPhraseExtractionLROResults' | 'EntityLinkingLROResults' | 'HealthcareLROResults' | 'CustomEntityRecognitionLROResults' | 'CustomSingleLabelClassificationLROResults' | 'CustomMultiLabelClassificationLROResults' | 'ExtractiveSummarizationLROResults' | 'AbstractiveSummarizationLROResults', required — The kind of the response object returned by the analyze-text long running task.
  - `statistics` RequestStatistics — if showStats=true was specified in the request this field will contain information about the request payload.
    - `documentsCount` integer, required — Number of documents submitted in the request.
    - `validDocumentsCount` integer, required — Number of valid documents. This excludes empty, over-size limit or non-supported languages documents.
    - `erroneousDocumentsCount` integer, required — Number of invalid documents. This includes empty, over-size limit or non-supported languages documents.
    - `transactionsCount` integer, required — Number of transactions for the request.

## Other responses

- `default` — An unexpected error response.

---

[API](https://skmtc.net/azure/apis/cognitiveservices-languageanalyzetext.md) · [All operations](https://skmtc.net/azure/apis/cognitiveservices-languageanalyzetext/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/cognitiveservices-languageanalyzetext/revisions/87a54ae2fce6/schema)